Documentation has incorrect rendering of spaces for the indent-string option #8392
Labels
Documentation 📗
Good first issue
Friendly and approachable by new contributors
Help wanted 🙏
Outside help would be appreciated, good for new contributors
Needs PR
This issue is accepted, sufficiently specified and now needs an implementation
Bug description
In the documentation for the indent string option the code
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
Pylint output
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
OS / Environment
No response
Additional dependencies
No response
The text was updated successfully, but these errors were encountered: