Skip to content

DOC: GL01 errors in shared_docs.py #36874

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
Iqrar99 opened this issue Oct 5, 2020 · 0 comments · Fixed by #36875
Closed

DOC: GL01 errors in shared_docs.py #36874

Iqrar99 opened this issue Oct 5, 2020 · 0 comments · Fixed by #36875
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Milestone

Comments

@Iqrar99
Copy link
Contributor

Iqrar99 commented Oct 5, 2020

Location of the documentation

shared_docs.py

"aggregate"
] = """\
Aggregate using one or more operations over the specified axis.

"compare"
] = """\
Compare to another %(klass)s and show the differences.

"groupby"
] = """\
Group %(klass)s using a mapper or by a Series of columns.

"melt"
] = """\
Unpivot a DataFrame from wide to long format, optionally leaving identifiers set.

"transform"
] = """\
Call ``func`` on self producing a {klass} with transformed values.

Documentation problem

GL01 pandas docstring errors. Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between.

Suggested fix for documentation

It's really unnecessary using \ to break the line when using """ as the docstring. It also treats the next line as the same line. Remove the \ instead.

@Iqrar99 Iqrar99 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 5, 2020
@jreback jreback added this to the 1.2 milestone Oct 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants