From c794e0813fcb901d326ce36f13fef830f6031e56 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Mon, 23 May 2022 12:11:29 +0200 Subject: [PATCH 1/2] [doc] Move the naming-style documentation to invalid-name doc --- doc/conf.py | 1 + doc/data/messages/i/invalid-name/bad.py | 8 ++++++++ .../messages/i/invalid-name/details.rst} | 9 --------- doc/data/messages/i/invalid-name/good.py | 8 ++++++++ doc/user_guide/options.rst | 1 - 5 files changed, 17 insertions(+), 10 deletions(-) create mode 100644 doc/data/messages/i/invalid-name/bad.py rename doc/{user_guide/configuration/naming-styles.rst => data/messages/i/invalid-name/details.rst} (98%) create mode 100644 doc/data/messages/i/invalid-name/good.py diff --git a/doc/conf.py b/doc/conf.py index 954aaf626a..da618cf252 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -62,6 +62,7 @@ "messages/messages_list": "../user_guide/messages/messages_overview.html", "user_guide/message-control": "messages/message_control.html", "technical_reference/c_extensions": "../user_guide/messages/error/no-member.html", + "user_guide/configuration/naming-styles": "../user_guide/messages/convention/invalid-name.html", "development/testing": "tests/index.html", } diff --git a/doc/data/messages/i/invalid-name/bad.py b/doc/data/messages/i/invalid-name/bad.py new file mode 100644 index 0000000000..fac9b49472 --- /dev/null +++ b/doc/data/messages/i/invalid-name/bad.py @@ -0,0 +1,8 @@ +class cat: # [invalid-name] + + def Meow(self, NUMBER_OF_MEOW): # [invalid-name, invalid-name] + print("Meow" * NUMBER_OF_MEOW) + return NUMBER_OF_MEOW + + +Cat = cat().Meow(42) # [invalid-name] diff --git a/doc/user_guide/configuration/naming-styles.rst b/doc/data/messages/i/invalid-name/details.rst similarity index 98% rename from doc/user_guide/configuration/naming-styles.rst rename to doc/data/messages/i/invalid-name/details.rst index b27e736768..0a612101ef 100644 --- a/doc/user_guide/configuration/naming-styles.rst +++ b/doc/data/messages/i/invalid-name/details.rst @@ -1,12 +1,3 @@ -.. -*- coding: utf-8 -*- - -=============== - Naming styles -=============== - -Introduction -~~~~~~~~~~~~ - Pylint recognizes a number of different name types internally. With a few exceptions, the type of the name is governed by the location the assignment to a name is found in, and not the type of object assigned. diff --git a/doc/data/messages/i/invalid-name/good.py b/doc/data/messages/i/invalid-name/good.py new file mode 100644 index 0000000000..3decdb3e4a --- /dev/null +++ b/doc/data/messages/i/invalid-name/good.py @@ -0,0 +1,8 @@ +class Cat: + + def meow(self, number_of_meow): + print("Meow" * number_of_meow) + return number_of_meow + + +CAT = Cat().meow(42) diff --git a/doc/user_guide/options.rst b/doc/user_guide/options.rst index 6ba27ef1b8..135034df9d 100644 --- a/doc/user_guide/options.rst +++ b/doc/user_guide/options.rst @@ -7,4 +7,3 @@ Configuration :titlesonly: configuration/all-options - configuration/naming-styles From b3b5894224587be87aba6531d85bd38a533a089f Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Mon, 23 May 2022 12:39:37 +0200 Subject: [PATCH 2/2] [doc] Add a '.gitkeep' in user_guide/configuration In order for the directory to exists so pylint_options do not need to create the directory. --- doc/user_guide/configuration/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 doc/user_guide/configuration/.gitkeep diff --git a/doc/user_guide/configuration/.gitkeep b/doc/user_guide/configuration/.gitkeep new file mode 100644 index 0000000000..e69de29bb2