Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alanhdu committed Nov 10, 2023
1 parent 9c01fde commit 161fd66
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions crates/ruff_workspace/src/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2397,9 +2397,26 @@ pub struct PydocstyleOptions {
/// convention = "google"
/// ```
///
/// As conventions force-disable all rules not included in the convention,
/// enabling _additional_ rules on top of a convention is currently
/// unsupported.
/// If you must, you can enable rules not included in a convention by
/// requesting the specific error code:
///
/// ```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
///
/// [tool.ruff.lint.pydocstyle]
/// convention = "google"
/// ```
#[option(
default = r#"null"#,
value_type = r#""google" | "numpy" | "pep257""#,
Expand Down

0 comments on commit 161fd66

Please sign in to comment.