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

Timestamp docstring with missing periods #134

Closed
datapythonista opened this issue Aug 18, 2019 · 5 comments
Closed

Timestamp docstring with missing periods #134

datapythonista opened this issue Aug 18, 2019 · 5 comments
Assignees
Labels

Comments

@datapythonista
Copy link
Member

Same as #132, but for some other docstrings.

pandas.Timestamp.resolution: Summary does not end with a period
pandas.Timestamp.tz: Summary does not end with a period
pandas.Timestamp.ceil: Summary does not end with a period
pandas.Timestamp.combine: Summary does not end with a period
pandas.Timestamp.floor: Summary does not end with a period
pandas.Timestamp.fromordinal: Summary does not end with a period
pandas.Timestamp.isoweekday: Summary does not end with a period
pandas.Timestamp.replace: Summary does not end with a period
pandas.Timestamp.round: Summary does not end with a period
pandas.Timestamp.weekday: Summary does not end with a period
pandas.Timedelta.ceil: Summary does not end with a period
pandas.Timedelta.floor: Summary does not end with a period
pandas.Timedelta.isoformat: Summary does not end with a period
pandas.Timedelta.round: Summary does not end with a period
@sparalic sparalic self-assigned this Aug 20, 2019
@sparalic
Copy link
Member

@datapythonista I can pick up this one as well

@datapythonista
Copy link
Member Author

Cool. The list was generated with ./scripts/validate_docstring.py --errors=SS03, and I created issues for batches of those. If you want to create new issues for errors like this in this report, you can find more info here: pandas-dev/pandas#27977

@sparalic
Copy link
Member

@datapythonista will do. Marc, I noticed that I was bouncing around several different sources and piecing together things to get things set-up to simply run this validation script. Would it help if I add some end-to-end instructions from setting ups the pandas env run the validate script all the way to submitting your changes? Maybe in the lessons learned or contribution md file?

It would combine these two sets of information:

  1. https://python-sprints.github.io/pandas/guide/pandas_pr.html#validate-that-your-docstring-does-not-have-technical-errors

  2. Setting up your pandas-dev: https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#contributing-dev-env

@datapythonista
Copy link
Member Author

Ideally we would have clear documentation on that in the pandas website itself. In the new website I did a bit of work on splitting the contributing docs, which goes in the direction that you're mentioning.

Feel free to create the document you propose. But it may be worth to wait until the initial PR for the website is merged, and then improve the docs there.

@sparalic
Copy link
Member

Closes: fix punctuation in Timestamp/Timedelta docstrings #28053 in pandas

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