Add mandatory doc

pylint-dev · Dec 4, 2023 · 99eb831 · 99eb831
1 parent 8a92b09
commit 99eb831
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/doc/data/messages/t/too-many-positional/details.rst b/doc/data/messages/t/too-many-positional/details.rst
@@ -0,0 +1 @@
+Reserved message name, not yet implemented.
diff --git a/doc/data/messages/t/too-many-positional/related.rst b/doc/data/messages/t/too-many-positional/related.rst
@@ -0,0 +1,2 @@
+- `Ruff discussion <https://github.com/astral-sh/ruff/issues/8946>`_
+- `Pylint issue <https://github.com/pylint-dev/pylint/issues/9099>`_
diff --git a/doc/user_guide/checkers/features.rst b/doc/user_guide/checkers/features.rst
@@ -431,6 +431,10 @@ Design checker Messages
   simpler (and so easier to use) class.
 :too-many-locals (R0914): *Too many local variables (%s/%s)*
   Used when a function or method has too many local variables.
+:too-many-positional (R0917): *Too many positional arguments in a function call.*
+  Will be implemented in https://github.com/pylint-
+  dev/pylint/issues/9099,msgid/symbol pair reserved for compatibility with
+  ruff, see https://github.com/astral-sh/ruff/issues/8946.
 :too-many-public-methods (R0904): *Too many public methods (%s/%s)*
   Used when class has too many public methods, try to reduce this to get a
   simpler (and so easier to use) class.

diff --git a/doc/user_guide/messages/messages_overview.rst b/doc/user_guide/messages/messages_overview.rst
@@ -532,6 +532,7 @@ All messages in the refactor category:
    refactor/too-many-instance-attributes
    refactor/too-many-locals
    refactor/too-many-nested-blocks
+   refactor/too-many-positional
    refactor/too-many-public-methods
    refactor/too-many-return-statements
    refactor/too-many-statements