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

Fix docstrings where the summary does not end with a period. #132

Open
datapythonista opened this issue Aug 17, 2019 · 2 comments
Open

Fix docstrings where the summary does not end with a period. #132

datapythonista opened this issue Aug 17, 2019 · 2 comments
Assignees
Labels

Comments

@datapythonista
Copy link
Member

datapythonista commented Aug 17, 2019

In pandas we try to make sure that all the documentation pages follow the same conventions. For example, we expect all the summaries to finish with a period.

Here there is a list of docstrings that don't follow this convention:

pandas.DataFrame.keys: Summary does not end with a period
pandas.read_clipboard: Summary does not end with a period
pandas.ExcelFile.parse: Summary does not end with a period
pandas.HDFStore.put: Summary does not end with a period
pandas.HDFStore.get: Summary does not end with a period
pandas.HDFStore.select: Summary does not end with a period
pandas.HDFStore.keys: Summary does not end with a period
pandas.HDFStore.groups: Summary does not end with a period
pandas.HDFStore.walk: Summary does not end with a period
pandas.io.stata.StataReader.data: Summary does not end with a period
pandas.io.formats.style.Styler.loader: Summary does not end with a period
pandas.io.formats.style.Styler.set_caption: Summary does not end with a period
pandas.plotting.deregister_matplotlib_converters: Summary does not end with a period
pandas.plotting.register_matplotlib_converters: Summary does not end with a period

You can see the first one, how the first sentence should finish with a period and it doesn't: https://dev.pandas.io/reference/api/pandas.DataFrame.keys.html

Please tag me @datapythonista when opening the PR in pandas. Thanks!

@Aya-S
Copy link
Contributor

Aya-S commented Aug 17, 2019

I will attempt this. These are all just missing ending periods right :D?
I opened an issue in pandas with you mentioned

@Aya-S Aya-S self-assigned this Aug 17, 2019
@datapythonista
Copy link
Member Author

Thanks @Aya-S. My bad that I mentioned about opening the issue in pandas, I meant the PR.

I think someone else worked on them, you can check in the open PRs what they did. But I've got some more you can fix, and yes, it's literally adding some periods . :)

pandas.Period: Summary does not end with a period
pandas.Period.asfreq: Summary does not end with a period
pandas.Period.strftime: Summary does not end with a period
pandas.Period.to_timestamp: Summary does not end with a period
pandas.Interval.closed: Summary does not end with a period
pandas.Interval.left: Summary does not end with a period
pandas.Interval.length: Summary does not end with a period
pandas.Interval.mid: Summary does not end with a period
pandas.Interval.right: Summary does not end with a period

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants