Documentation has incorrect rendering of spaces for the indent-string option · pylint-dev/pylint#8392

(9 comments) (1 reaction) (1 assignee)Python (4,978 stars) (1,059 forks)batch import

Documentation :green_book:Good first issueHacktoberfestHelp wanted 🙏Needs PR

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. 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

No response

N/A

N/A

Something along the lines of:

String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab). Default: " "

Appears on the newest version of Pylint taken from GitHub

No response

No response

Tech stack: python
Domain: documentation
Issue type: documentation
Difficulty: 1
Estimated time: under 1 hour
Activity status: active
Clarity: clear
Prerequisites: None
Newbie friendliness: 95
Research direction: The issue reports that the documentation for the indent string option renders spaces incorrectly because Markdown/HTML collapses multiple whitespaces. The solution is to use non breaking spaces (e.g., ` `) or wrap the default value in a code block to preserve whitespace. Locate the documentation file (likely a `.rst` or `.md` file in the repository) that contains the indent string option description and apply the fix. Test the rendering locally or refer to the issue comments for discussion on the approach.