mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-07-24 13:33:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Document conventions in the FAQ (#8638)

Browse source 
Enumerates all rules defined in each convention in the FAQ. These lists
mirror
[pydocstyle](https://www.pydocstyle.org/en/latest/error_codes.html#default-conventions).

Closes https://github.com/astral-sh/ruff/issues/8573.
This commit is contained in:
Charlie Marsh 2023-11-12 14:56:39 -08:00 • committed by GitHub
parent 02946e7b0c
commit 7fd95e15d9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 92 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

14
crates/ruff_workspace/src/options.rs
View file

@ -2383,10 +2383,10 @@ pub struct PydocstyleOptions {
/// Whether to use Google-style or NumPy-style conventions or the [PEP 257](https://peps.python.org/pep-0257/)
/// defaults when analyzing docstring sections.
///
/// Enabling a convention will force-disable any rules that are not
/// included in the specified convention. As such, the intended use is
/// to enable a convention and then selectively disable any additional
/// rules on top of it.
/// Enabling a convention will disable all rules that are not included in
/// the specified convention. As such, the intended workflow is to enable a
/// convention and then selectively enable or disable any additional rules
/// on top of it.
///
/// For example, to use Google-style conventions but avoid requiring
/// documentation for every function parameter:
@ -2405,9 +2405,9 @@ pub struct PydocstyleOptions {
/// convention = "google"
/// ```
///
/// 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`):
/// To enable an additional rule that's excluded from the convention,
/// select the desired rule via its fully qualified rule code (e.g.,
/// `D400` instead of `D4` or `D40`):
///
/// ```toml
/// [tool.ruff.lint]