Skip to content

DOC: GL01 errors in shared_docs.py #36874

Closed
@Iqrar99

Description

@Iqrar99

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsNeeds TriageIssue that has not been reviewed by a pandas team member

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions