Add Param variants to Numpy-style rather than Google style

astral-sh · Apr 22, 2023 · 72b73ca · 72b73ca
1 parent c62222a
commit 72b73ca
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 6 deletions.
diff --git a/crates/ruff/src/docstrings/google.rs b/crates/ruff/src/docstrings/google.rs
@@ -28,8 +28,6 @@ pub(crate) static GOOGLE_SECTIONS: &[SectionKind] = &[
     SectionKind::Notes,
     SectionKind::OtherArgs,
     SectionKind::OtherArguments,
-    SectionKind::OtherParams,
-    SectionKind::OtherParameters,
     SectionKind::Return,
     SectionKind::Tip,
     SectionKind::Todo,

diff --git a/crates/ruff/src/docstrings/numpy.rs b/crates/ruff/src/docstrings/numpy.rs
@@ -14,6 +14,7 @@ pub(crate) static NUMPY_SECTIONS: &[SectionKind] = &[
     SectionKind::Yields,
     // NumPy-only
     SectionKind::ExtendedSummary,
+    SectionKind::OtherParams,
     SectionKind::OtherParameters,
     SectionKind::Parameters,
     SectionKind::ShortSummary,

diff --git a/crates/ruff/src/rules/pydocstyle/rules/sections.rs b/crates/ruff/src/rules/pydocstyle/rules/sections.rs
@@ -298,7 +298,9 @@ pub fn sections(checker: &mut Checker, docstring: &Docstring, convention: Option
             if numpy_sections.iter().any(|context| {
                 matches!(
                     context.kind,
-                    SectionKind::Parameters | SectionKind::OtherParameters
+                    SectionKind::Parameters
+                        | SectionKind::OtherParams
+                        | SectionKind::OtherParameters
                 )
             }) {
                 for context in &numpy_sections {
@@ -1068,9 +1070,6 @@ fn parse_google_sections(checker: &mut Checker, lines: &[&str], docstring: &Docs
                 | SectionKind::KeywordArguments
                 | SectionKind::OtherArgs
                 | SectionKind::OtherArguments
-                | SectionKind::OtherParams
-                | SectionKind::OtherParameters
-                | SectionKind::Parameters
         ) {
             documented_args.extend(args_section(section_context));
         }