Skip to content

DOC: Wrong spaces in the documentation #23780

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

Closed
datapythonista opened this issue Nov 19, 2018 · 3 comments · Fixed by #23805
Closed

DOC: Wrong spaces in the documentation #23780

datapythonista opened this issue Nov 19, 2018 · 3 comments · Fixed by #23805
Labels
Code Style Code style, linting, code_checks Docs good first issue
Milestone

Comments

@datapythonista
Copy link
Member

In #23738 we fixed many cases where a space was missing before the colon splitting the parameter name and the type (e.g. name: str changed to name : str).

But in few cases spaces were added in places where they were not required or wrong, for example:

  • In directives: .. deprecated :: 0.21.0
  • In rst lists: Series : the user provides a pandas.Series object of the same
  • In code: "border" : {"top": "thin",

We should restore those cases and remove the added spaces.

@bk521234
Copy link
Contributor

I'll take a stab at this. We want to remove all of the spaces before colons if it is not a parameter?

should I use commit f247355 to see what parts of the documentation were refactored and adjust non parameter documentation?

@datapythonista
Copy link
Member Author

That's right, use better https://github.com/pandas-dev/pandas/pull/23738/files to see what was fixed, and remove the spaces in the examples shown in the description, and equivalent cases.

e.g. .. deprecated :: 0.21.0 -> .. deprecated:: 0.21.0

@bk521234
Copy link
Contributor

bk521234 commented Nov 19, 2018

Excellent! I'll get on this tonight..

@datapythonista thank you for the direction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Style Code style, linting, code_checks Docs good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants