-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Open
Labels
Documentation 📗Good first issueFriendly and approachable by new contributorsFriendly and approachable by new contributorsHelp wanted 🙏Outside help would be appreciated, good for new contributorsOutside help would be appreciated, good for new contributorsNeeds PRThis issue is accepted, sufficiently specified and now needs an implementationThis issue is accepted, sufficiently specified and now needs an implementation
Description
Bug description
In the documentation for the indent string option the code
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string=" "
Is rendered incorrectly due to markdown or html folding multiple whitespaces into one i.e. (the " " into " "). As such the documentation currently appears as:
This can create a bit of confusion when attempting to change this option, as seen in https://stackoverflow.com/q/54117674/7052741
Configuration
No response
Command used
N/A
Pylint output
N/A
Expected behavior
Something along the lines of:
--indent-string
String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab).
Default: " "
Pylint version
Appears on the newest version of Pylint taken from GitHub
OS / Environment
No response
Additional dependencies
No response
Metadata
Metadata
Assignees
Labels
Documentation 📗Good first issueFriendly and approachable by new contributorsFriendly and approachable by new contributorsHelp wanted 🙏Outside help would be appreciated, good for new contributorsOutside help would be appreciated, good for new contributorsNeeds PRThis issue is accepted, sufficiently specified and now needs an implementationThis issue is accepted, sufficiently specified and now needs an implementation