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: clarify the use of the where section in configurable rules #1538

Merged
merged 7 commits into from May 20, 2024

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Apr 24, 2024

What/Why/How?

This PR clarifies how to use the where section in configurable rules + minor formatting improvements.

Also, I think we can mention the current behaviour of the narrowing (it stops at the first level) which stems from the original behaviour of the nested visitors. But I haven't figured out yet how to better explain that (and if it's a proper behaviour at all).

Reference

Testing

Screenshots (optional)

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

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

@tatomyr tatomyr self-assigned this Apr 24, 2024
@tatomyr tatomyr requested a review from a team as a code owner April 24, 2024 13:24
Copy link

changeset-bot bot commented Apr 24, 2024

⚠️ No Changeset found

Latest commit: bc3dc65

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 Apr 24, 2024

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 973.5 ± 30.3 940.8 1046.2 1.00 ± 0.04
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 970.7 ± 26.0 938.7 1016.3 1.00

Copy link
Contributor

github-actions bot commented Apr 24, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 77.23% 4481/5802
🟡 Branches 67.51% 2468/3656
🟡 Functions 70.86% 744/1050
🟡 Lines 77.44% 4215/5443

Test suite run success

735 tests passing in 102 suites.

Report generated by 🧪jest coverage report action from bc3dc65

@tatomyr tatomyr requested a review from adamaltman April 24, 2024 13:28
@lornajane lornajane requested a review from a team April 25, 2024 20:24
@tatomyr tatomyr requested a review from lornajane May 15, 2024 11:09
@tatomyr tatomyr force-pushed the docs/clarify-the-where-list branch from 373a821 to cf7a537 Compare May 15, 2024 11:09
Copy link
Collaborator

@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.

Thanks for adding this

@tatomyr tatomyr force-pushed the docs/clarify-the-where-list branch from 1d39ab9 to bc3dc65 Compare May 20, 2024 11:58
@tatomyr tatomyr merged commit 7a49668 into main May 20, 2024
32 checks passed
@tatomyr tatomyr deleted the docs/clarify-the-where-list branch May 20, 2024 12:06
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.

None yet

3 participants