Improve consistency of some rule docs (#2887)

astral-sh · Feb 14, 2023 · f751573 · f751573
1 parent 53e810e
commit f751573
Show file tree

Hide file tree

Showing 10 changed files with 8 additions and 14 deletions.
diff --git a/clippy.toml b/clippy.toml
@@ -0,0 +1 @@
+doc-valid-idents = ["StackOverflow", "CodeQL", ".."]
diff --git a/crates/ruff/src/rules/flake8_no_pep420/rules.rs b/crates/ruff/src/rules/flake8_no_pep420/rules.rs
@@ -25,7 +25,6 @@ define_violation!(
     /// the absence of the `__init__.py` file is probably an oversight.
     ///
     /// ## Options
-    ///
     /// * `namespace-packages`
     pub struct ImplicitNamespacePackage {
         pub filename: String,

diff --git a/crates/ruff/src/rules/flake8_pyi/rules/unrecognized_platform.rs b/crates/ruff/src/rules/flake8_pyi/rules/unrecognized_platform.rs
@@ -36,7 +36,7 @@ define_violation!(
     /// ```
     ///
     /// ## References
-    /// - [PEP 484](https://peps.python.org/pep-0484/#version-and-platform-checking)
+    /// * [PEP 484](https://peps.python.org/pep-0484/#version-and-platform-checking)
     pub struct UnrecognizedPlatformCheck;
 );
 impl Violation for UnrecognizedPlatformCheck {
@@ -72,7 +72,7 @@ define_violation!(
     /// ```
     ///
     /// ## References
-    /// - [PEP 484](https://peps.python.org/pep-0484/#version-and-platform-checking)
+    /// * [PEP 484](https://peps.python.org/pep-0484/#version-and-platform-checking)
     pub struct UnrecognizedPlatformName {
         pub platform: String,
     }

diff --git a/crates/ruff/src/rules/flake8_quotes/rules.rs b/crates/ruff/src/rules/flake8_quotes/rules.rs
@@ -21,7 +21,6 @@ define_violation!(
     /// strings, but be consistent.
     ///
     /// ## Options
-    ///
     /// * `flake8-quotes.inline-quotes`
     ///
     /// ## Example
@@ -67,7 +66,6 @@ define_violation!(
     /// strings, but be consistent.
     ///
     /// ## Options
-    ///
     /// * `flake8-quotes.multiline-quotes`
     ///
     /// ## Example
@@ -116,7 +114,6 @@ define_violation!(
     /// strings, but be consistent.
     ///
     /// ## Options
-    ///
     /// * `flake8-quotes.docstring-quotes`
     ///
     /// ## Example

diff --git a/crates/ruff/src/rules/flake8_tidy_imports/relative_imports.rs b/crates/ruff/src/rules/flake8_tidy_imports/relative_imports.rs
@@ -49,7 +49,6 @@ define_violation!(
     /// > ```
     ///
     /// ## Options
-    ///
     /// * `flake8-tidy-imports.ban-relative-imports`
     ///
     /// ## Example

diff --git a/crates/ruff/src/rules/mccabe/rules.rs b/crates/ruff/src/rules/mccabe/rules.rs
@@ -19,7 +19,6 @@ define_violation!(
     /// Functions with a high complexity are hard to understand and maintain.
     ///
     /// ## Options
-    ///
     /// * `mccabe.max-complexity`
     ///
     /// ## Example

diff --git a/crates/ruff/src/rules/pandas_vet/rules/inplace_argument.rs b/crates/ruff/src/rules/pandas_vet/rules/inplace_argument.rs
@@ -31,7 +31,7 @@ define_violation!(
     /// ```
     ///
     /// ## References
-    /// - [Why You Should Probably Never Use pandas inplace=True](https://towardsdatascience.com/why-you-should-probably-never-use-pandas-inplace-true-9f9f211849e4)
+    /// * [_Why You Should Probably Never Use pandas inplace=True_](https://towardsdatascience.com/why-you-should-probably-never-use-pandas-inplace-true-9f9f211849e4)
     pub struct UseOfInplaceArgument;
 );
 impl AlwaysAutofixableViolation for UseOfInplaceArgument {

diff --git a/crates/ruff/src/rules/pycodestyle/rules/bare_except.rs b/crates/ruff/src/rules/pycodestyle/rules/bare_except.rs
@@ -33,9 +33,9 @@ define_violation!(
     /// ```
     ///
     /// ## References
-    /// - [PEP 8](https://www.python.org/dev/peps/pep-0008/#programming-recommendations)
-    /// - [Python: "Exception hierarchy"](https://docs.python.org/3/library/exceptions.html#exception-hierarchy)
-    /// - [Google Python Style Guide: "Exceptions"](https://google.github.io/styleguide/pyguide.html#24-exceptions)
+    /// * [PEP 8](https://www.python.org/dev/peps/pep-0008/#programming-recommendations)
+    /// * [Python: "Exception hierarchy"](https://docs.python.org/3/library/exceptions.html#exception-hierarchy)
+    /// * [Google Python Style Guide: "Exceptions"](https://google.github.io/styleguide/pyguide.html#24-exceptions)
     pub struct BareExcept;
 );
 impl Violation for BareExcept {

diff --git a/crates/ruff/src/rules/pyflakes/rules/unused_variable.rs b/crates/ruff/src/rules/pyflakes/rules/unused_variable.rs
@@ -28,7 +28,6 @@ define_violation!(
     /// [`dummy-variable-rgx`] pattern.
     ///
     /// ## Options
-    ///
     /// * `dummy-variable-rgx`
     ///
     /// ## Example

diff --git a/crates/ruff/src/rules/pylint/rules/yield_in_init.rs b/crates/ruff/src/rules/pylint/rules/yield_in_init.rs
@@ -32,7 +32,7 @@ define_violation!(
     /// ```
     ///
     /// ## References
-    /// * [`py-init-method-is-generator`](https://codeql.github.com/codeql-query-help/python/py-init-method-is-generator/)
+    /// * [CodeQL: `py-init-method-is-generator`](https://codeql.github.com/codeql-query-help/python/py-init-method-is-generator/)
     pub struct YieldInInit;
 );