search

python-sprints / pandas-mentoring

Mentoring new pandas contributors.
BSD 3-Clause "New" or "Revised" License
6 stars 30 forks source link

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

Open datapythonista opened 5 years ago

datapythonista commented 5 years ago

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 commented 5 years ago

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

datapythonista commented 5 years ago

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