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

Add consistent period in options documentation (#7725)

Browse source
This commit is contained in:
Charlie Marsh 2023-09-30 19:07:30 -04:00 • committed by GitHub
parent 1646939383
commit c782770e90
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -138,7 +138,7 @@ pub struct Options {
default = "false",
value_type = "bool",
example = r#"
# Enable preview features
# Enable preview features.
preview = true
"#
)]
@ -577,7 +577,7 @@ pub struct LintOptions {
default = "false",
value_type = "bool",
example = r#"
# Require explicit selection of preview rules
# Require explicit selection of preview rules.
explicit-preview-rules = true
"#
)]
@ -1821,7 +1821,7 @@ pub struct IsortOptions {
default = r#"0"#,
value_type = "int",
example = r#"
# Use a single line between direct and from import
# Use a single line between direct and from import.
lines-between-types = 1
"#
)]
@ -2096,7 +2096,7 @@ pub struct Pep8NamingOptions {
///
/// Supports glob patterns. For example, to ignore all names starting with
/// or ending with `_test`, you could use `ignore-names = ["test_*", "*_test"]`.
/// For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax)..
/// For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).
#[option(
default = r#"[]"#,
value_type = "list[str]",

2
ruff.schema.json generated
View file

@ -2034,7 +2034,7 @@
}
},
"extend-ignore-names": {
"description": "Additional names (or patterns) to ignore when considering `pep8-naming` violations, in addition to those included in `ignore-names`\n\nSupports glob patterns. For example, to ignore all names starting with or ending with `_test`, you could use `ignore-names = [\"test_*\", \"*_test\"]`. For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax)..",
"description": "Additional names (or patterns) to ignore when considering `pep8-naming` violations, in addition to those included in `ignore-names`\n\nSupports glob patterns. For example, to ignore all names starting with or ending with `_test`, you could use `ignore-names = [\"test_*\", \"*_test\"]`. For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).",
"type": [
"array",
"null"