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: correct description of multiline patterns usage based on #1353 #1380

Merged
merged 4 commits into from
Jan 4, 2024

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Jan 4, 2024

What/Why/How?

The description was not quite correct. Fixed based on #1351 (kudos to @jeremyfiel!).

Reference

Testing

Screenshots (optional)

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

@tatomyr tatomyr requested a review from a team as a code owner January 4, 2024 09:10
Copy link

changeset-bot bot commented Jan 4, 2024

⚠️ No Changeset found

Latest commit: 1a7b7bd

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 Jan 4, 2024

Command Mean [s] Min [s] Max [s] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 1.073 ± 0.041 1.038 1.180 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 1.073 ± 0.015 1.054 1.096 1.00 ± 0.04

Copy link
Contributor

github-actions bot commented Jan 4, 2024

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 1a7b7bd

Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for getting deep into this and sorting out the details!

docs/rules/configurable-rules.md Outdated Show resolved Hide resolved
your pattern.
Take care using `notPattern` with multiline Markdown values such as `description` fields.
These may end with a newline or a space rather than the character you expect.
Use the [double-quotated style](https://yaml.org/spec/1.2.2/#731-double-quoted-style) or take account of this in your pattern.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the [double-quotated style](https://yaml.org/spec/1.2.2/#731-double-quoted-style) or take account of this in your pattern.
Use the [double-quoted style](https://yaml.org/spec/1.2.2/#731-double-quoted-style) or take account of this in your pattern.

docs/rules/configurable-rules.md Outdated Show resolved Hide resolved
tatomyr and others added 2 commits January 4, 2024 12:49
@tatomyr tatomyr merged commit 7c7198d into main Jan 4, 2024
30 checks passed
@tatomyr tatomyr deleted the docs/multiline-patterns branch January 4, 2024 10:56
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.

2 participants