Skip to content

Commit ef40b99

Browse files
[doc] Move the naming-style documentation to invalid-name doc (#6669)
Add a '.gitkeep' in user_guide/configuration In order for the directory to exists so pylint_options do not need to create the directory.
1 parent 7049e77 commit ef40b99

File tree

6 files changed

+17
-10
lines changed

6 files changed

+17
-10
lines changed

doc/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
"messages/messages_list": "../user_guide/messages/messages_overview.html",
6363
"user_guide/message-control": "messages/message_control.html",
6464
"technical_reference/c_extensions": "../user_guide/messages/error/no-member.html",
65+
"user_guide/configuration/naming-styles": "../user_guide/messages/convention/invalid-name.html",
6566
"development/testing": "tests/index.html",
6667
}
6768

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
class cat: # [invalid-name]
2+
3+
def Meow(self, NUMBER_OF_MEOW): # [invalid-name, invalid-name]
4+
print("Meow" * NUMBER_OF_MEOW)
5+
return NUMBER_OF_MEOW
6+
7+
8+
Cat = cat().Meow(42) # [invalid-name]

doc/user_guide/configuration/naming-styles.rst renamed to doc/data/messages/i/invalid-name/details.rst

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
.. -*- coding: utf-8 -*-
2-
3-
===============
4-
Naming styles
5-
===============
6-
7-
Introduction
8-
~~~~~~~~~~~~
9-
101
Pylint recognizes a number of different name types internally. With a few
112
exceptions, the type of the name is governed by the location the assignment to a
123
name is found in, and not the type of object assigned.
+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
class Cat:
2+
3+
def meow(self, number_of_meow):
4+
print("Meow" * number_of_meow)
5+
return number_of_meow
6+
7+
8+
CAT = Cat().meow(42)

doc/user_guide/configuration/.gitkeep

Whitespace-only changes.

doc/user_guide/options.rst

-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@ Configuration
77
:titlesonly:
88

99
configuration/all-options
10-
configuration/naming-styles

0 commit comments

Comments
 (0)