Skip to content

Commit

Permalink
Tweak docs
Browse files Browse the repository at this point in the history
  • Loading branch information
charliermarsh committed Nov 10, 2023
1 parent a29b1a8 commit e18d884
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
18 changes: 5 additions & 13 deletions crates/ruff_workspace/src/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2405,22 +2405,14 @@ pub struct PydocstyleOptions {
/// convention = "google"
/// ```
///
/// If you must, you can enable rules not included in a convention by
/// requesting the specific error code:
/// To modify a convention (i.e., to enable an additional rule that's excluded
/// from the convention by default), select the desired rule via its fully
/// qualified rule code (e.g., `D400` instead of `D4` or `D40`):
///
/// ```toml
/// [tool.ruff.lint]
/// extend-select = ["D400"] # will enable D400 rule
///
/// [tool.ruff.lint.pydocstyle]
/// convention = "google"
/// ```
///
/// Just adding a rule prefix will not enable convention-specified rules.
///
/// ```toml
/// [tool.ruff.lint]
/// extend-select = ["D40"] # will *not* enable D400 rule
/// # Enable D400 on top of the Google convention.
/// extend-select = ["D400"]
///
/// [tool.ruff.lint.pydocstyle]
/// convention = "google"
Expand Down
2 changes: 1 addition & 1 deletion ruff.schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e18d884

Please sign in to comment.