mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-02 09:52:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[pydocstyle] Add setting to ignore missing documentation for*args and **kwargs parameters (D417) (#15210)

Browse source 
Co-authored-by: Micha Reiser <micha@reiser.io>
This commit is contained in:
InSync 2024-12-31 18:16:55 +07:00 • committed by GitHub
parent 3c9021ffcb
commit cfd6093579
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 285 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,7 +2,7 @@ use regex::Regex;
use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet};
use serde::de::{self};
use serde::{Deserialize, Deserializer, Serialize};
use std::collections::BTreeMap;
use std::collections::{BTreeMap, BTreeSet};
use std::path::PathBuf;
use strum::IntoEnumIterator;
@ -2836,6 +2836,16 @@ pub struct PydocstyleOptions {
"#
)]
pub property_decorators: Option<Vec<String>>,
/// If set to `true`, ignore missing documentation for `*args` and `**kwargs` parameters.
#[option(
default = r#"false"#,
value_type = "bool",
example = r#"
ignore_var_parameters = true
"#
)]
pub ignore_var_parameters: Option<bool>,
}
impl PydocstyleOptions {
@ -2844,12 +2854,14 @@ impl PydocstyleOptions {
convention,
ignore_decorators,
property_decorators,
ignore_var_parameters: ignore_variadics,
} = self;
pydocstyle::settings::Settings::new(
pydocstyle::settings::Settings {
convention,
ignore_decorators.unwrap_or_default(),
property_decorators.unwrap_or_default(),
)
ignore_decorators: BTreeSet::from_iter(ignore_decorators.unwrap_or_default()),
property_decorators: BTreeSet::from_iter(property_decorators.unwrap_or_default()),
ignore_var_parameters: ignore_variadics.unwrap_or_default(),
}
}
}