Skip to content

DOC: GL01 numpydoc validation #44567

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Nov 25, 2021
Merged

DOC: GL01 numpydoc validation #44567

merged 6 commits into from
Nov 25, 2021

Conversation

mroeschke
Copy link
Member

@mroeschke mroeschke added the Docs label Nov 22, 2021
@mroeschke mroeschke added this to the 1.4 milestone Nov 22, 2021
jreback
jreback reviewed Nov 25, 2021
View reviewed changes
pandas/io/formats/style_render.py
@@ -57,17 +57,23 @@ class CSSDict(TypedDict):
Subset = Union[slice, Sequence, Index]


def _gl01_adjust(obj: Any) -> Any:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

umm this seems kind of a hack, can we just adjust the templates?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the docstrings of jinja2.PackageLoader and jinja2.Environment I believe, and their docstrings don't conform with GL01 cc @attack68

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thats right these are inherited docstring objects.

is there a way we can prevent the doc string validation is such cases? might be better than overwriting it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Looks like the validation script doesn't have any capabilities to ignore certain objects or methods; it looks to check everything in the public API.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok merging

but maybe would be good to enable some ignoring to prevent having to do this

@jreback jreback merged commit 63945c0 into pandas-dev:master Nov 25, 2021
@mroeschke mroeschke deleted the doc/gl03 branch November 26, 2021 02:05
@mroeschke mroeschke mentioned this pull request Jul 28, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@attack68 attack68 attack68 left review comments

@jreback jreback jreback approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.4
Development

Successfully merging this pull request may close these issues.

Fix validation error type GL01 and check in CI
3 participants
@mroeschke @jreback @attack68