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.

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 missing config docstrings #15803

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions crates/ruff_workspace/src/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -942,6 +942,7 @@ pub struct LintCommonOptions {
// WARNING: Don't add new options to this type. Add them to `LintOptions` instead.
}

/// Options for the `flake8-annotations` plugin.
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
#[derive(
Clone, Debug, PartialEq, Eq, Default, OptionsMetadata, CombineOptions, Serialize, Deserialize,
Expand Down Expand Up @@ -1011,6 +1012,7 @@ impl Flake8AnnotationsOptions {
}
}

/// Options for the `flake8-bandit` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1059,6 +1061,7 @@ impl Flake8BanditOptions {
}
}

/// Options for the `flake8-boolean-trap` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand All @@ -1085,6 +1088,7 @@ impl Flake8BooleanTrapOptions {
}
}

/// Options for the `flake8-bugbear` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1115,6 +1119,8 @@ impl Flake8BugbearOptions {
}
}
}

/// Options for the `flake8-builtins` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1145,6 +1151,8 @@ impl Flake8BuiltinsOptions {
}
}
}

/// Options for the `flake8-comprehensions` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand All @@ -1170,6 +1178,7 @@ impl Flake8ComprehensionsOptions {
}
}

/// Options for the `flake8-copyright` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1225,6 +1234,7 @@ impl Flake8CopyrightOptions {
}
}

/// Options for the `flake8-errmsg` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand All @@ -1244,6 +1254,7 @@ impl Flake8ErrMsgOptions {
}
}

/// Options for the `flake8-gettext` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1281,6 +1292,7 @@ impl Flake8GetTextOptions {
}
}

/// Options for the `flake8-implicit-str-concat` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1315,6 +1327,7 @@ impl Flake8ImplicitStrConcatOptions {
}
}

/// Options for the `flake8-import-conventions` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1468,6 +1481,7 @@ impl Flake8ImportConventionsOptions {
}
}

/// Options for the `flake8-pytest-style` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1658,6 +1672,7 @@ impl Flake8PytestStyleOptions {
}
}

/// Options for the `flake8-quotes` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1730,6 +1745,7 @@ impl Flake8QuotesOptions {
}
}

/// Options for the `flake8_self` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1770,6 +1786,7 @@ impl Flake8SelfOptions {
}
}

/// Options for the `flake8-tidy-imports` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1827,6 +1844,7 @@ impl Flake8TidyImportsOptions {
}
}

/// Options for the `flake8-type-checking` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -1971,6 +1989,7 @@ impl Flake8TypeCheckingOptions {
}
}

/// Options for the `flake8-unused-arguments` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand All @@ -1994,6 +2013,7 @@ impl Flake8UnusedArgumentsOptions {
}
}

/// Options for the `isort` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -2641,6 +2661,7 @@ impl IsortOptions {
}
}

/// Options for the `mccabe` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -2669,6 +2690,7 @@ impl McCabeOptions {
}
}

/// Options for the `pep8-naming` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -2761,6 +2783,7 @@ impl Pep8NamingOptions {
}
}

/// Options for the `pycodestyle` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -2835,6 +2858,7 @@ impl PycodestyleOptions {
}
}

/// Options for the `pydocstyle` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -2942,6 +2966,7 @@ impl PydocstyleOptions {
}
}

/// Options for the `pydoclint` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -2971,6 +2996,7 @@ impl PydoclintOptions {
}
}

/// Options for the `pyflakes` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -3015,6 +3041,7 @@ impl PyflakesOptions {
}
}

/// Options for the `pylint` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -3124,6 +3151,7 @@ impl PylintOptions {
}
}

/// Options for the `pyupgrade` plugin.
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down Expand Up @@ -3179,6 +3207,7 @@ impl PyUpgradeOptions {
}
}

/// Options for the `ruff` plugin
#[derive(
Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions,
)]
Expand Down
Loading
Loading