Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation has incorrect rendering of spaces for the indent-string option #8392

Open
BenjaminCarpenter480 opened this issue Mar 6, 2023 · 3 comments · May be fixed by #9904
Open

Documentation has incorrect rendering of spaces for the indent-string option #8392

BenjaminCarpenter480 opened this issue Mar 6, 2023 · 3 comments · May be fixed by #9904
Assignees
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

Comments

@BenjaminCarpenter480
Copy link

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:
image

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

@BenjaminCarpenter480 BenjaminCarpenter480 added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Mar 6, 2023
@Pierre-Sassoulas Pierre-Sassoulas added Help wanted 🙏 Outside help would be appreciated, good for new contributors Good first issue Friendly and approachable by new contributors Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Mar 7, 2023
@Pierre-Sassoulas
Copy link
Member

Thank you for opening the issue. A fix would ideally fix all the value containing spaces in any option by using the proper rst rendering during generation.

@khushi-parikh
Copy link

Can I take up this issue? Currently the only fix I can find is using a code block for the part as whitespaces are preserved within it.

@Pierre-Sassoulas
Copy link
Member

Sure, I'm assigning this issue to you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
3 participants