Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add a note about expected newlines in multiline markdown fields #1372

Merged
merged 1 commit into from
Jan 2, 2024

Conversation

lornajane
Copy link
Contributor

What/Why/How?

Fixes #649 by adding a clarifying note that markdown fields may have trailing newlines.

Check yourself

  • Code is linted
  • Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@lornajane lornajane requested a review from a team as a code owner December 29, 2023 11:58
Copy link

changeset-bot bot commented Dec 29, 2023

⚠️ No Changeset found

Latest commit: dd5b617

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Dec 29, 2023

Command Mean [s] Min [s] Max [s] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 1.050 ± 0.022 1.024 1.101 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 1.051 ± 0.021 1.022 1.098 1.00 ± 0.03

Copy link
Contributor

github-actions bot commented Dec 29, 2023

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 76.31% 4100/5373
🟡 Branches 66.29% 2183/3293
🟡 Functions 68.42% 663/969
🟡 Lines 76.51% 3847/5028

Test suite run success

653 tests passing in 94 suites.

Report generated by 🧪jest coverage report action from dd5b617

@lornajane lornajane requested a review from a team December 29, 2023 14:47
@lornajane lornajane force-pushed the docs/multiline-markdown-regex branch from 6f602ff to dd5b617 Compare January 2, 2024 09:46
@lornajane lornajane merged commit 574541f into main Jan 2, 2024
29 checks passed
@lornajane lornajane deleted the docs/multiline-markdown-regex branch January 2, 2024 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add note about pattern matches on Markdown string fields
2 participants