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.

Sign up for GitHub

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

Add nursery documentation note to preview section #7671

Merged
merged 2 commits into from
Sep 27, 2023
Merged

Add nursery documentation note to preview section #7671

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8459290
Add nursery documentation note to preview section
zanieb Sep 26, 2023
8510aad
Update docs/preview.md
zanieb Sep 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,12 @@ preview = true
Or, if you provided the `--preview` CLI flag.

To see which rules are currently in preview, visit the [rules reference](rules.md).

## Legacy behavior

Before the preview mode was introduced, new rules were added in a "nursery" category that required selection of
rules with their exact code.

The nursery has been deprecated and all rules in the nursery are now considered to be in preview. For backwards
zanieb marked this conversation as resolved.
Show resolved Hide resolved
compatibility, nursery rules are selectable with their exact codes without enabling preview mode but a warning will
be displayed.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe "without enabling preview mode; however, use of such selectors to enable nursery rules will show a warning."?

Copy link
Member Author

@zanieb zanieb Sep 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Hm I don't love what I have but that's a bit confusing too. I think I will make this a bit clearer when I merge with #7390 which adds documentation for the exact code selection concept.