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.

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

DOCS: fix PR09,PR09 doc string errors in Timestamp, NaT, Timedelta class #28673

Closed
josibake opened this issue Sep 29, 2019 · 1 comment · Fixed by #28739
Closed

DOCS: fix PR09,PR09 doc string errors in Timestamp, NaT, Timedelta class #28673

josibake opened this issue Sep 29, 2019 · 1 comment · Fixed by #28739
Labels
Docs

Comments

@josibake
Copy link

josibake commented Sep 29, 2019 •
edited
Loading

This fixes validation errors PR09,PR08 for pandas.Timestamp, pandas.Timedelta (and also NaT) class:

pandas.Timestamp.ceil: Parameter "ambiguous" description should start with a capital letter
pandas.Timestamp.ceil: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.ceil: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.day_name: Parameter "locale" description should start with a capital letter
pandas.Timestamp.day_name: Parameter "locale" description should finish with "."
pandas.Timestamp.floor: Parameter "ambiguous" description should start with a capital letter
pandas.Timestamp.floor: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.floor: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.fromordinal: Parameter "ordinal" description should start with a capital letter
pandas.Timestamp.fromordinal: Parameter "ordinal" description should finish with "."
pandas.Timestamp.fromordinal: Parameter "freq" description should finish with "."
pandas.Timestamp.month_name: Parameter "locale" description should start with a capital letter
pandas.Timestamp.month_name: Parameter "locale" description should finish with "."
pandas.Timestamp.now: Parameter "tz" description should finish with "."
pandas.Timestamp.round: Parameter "ambiguous" description should start with a capital letter
pandas.Timestamp.round: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.round: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.today: Parameter "tz" description should finish with "."
pandas.Timestamp.tz_localize: Parameter "ambiguous" description should finish with "."
pandas.Timestamp.tz_localize: Parameter "nonexistent" description should finish with "."
pandas.Timestamp.tz_localize: Parameter "errors" description should start with a capital letter
pandas.Timestamp.tz_localize: Parameter "errors" description should finish with "."
pandas.Timedelta.max: Parameter "unit" description should finish with "."
pandas.Timedelta.min: Parameter "unit" description should finish with "."

This is a subset of #28602 and #27977
josibake pushed a commit to josibake/pandas that referenced this issue Sep 29, 2019
DOC: fix PR09 doc string errors in Timestamp class
f3d45aa 
This fixes Parameter {} description should finish with "."
in the Timestamp class

closes pandas-dev#28673
@josibake josibake mentioned this issue Sep 29, 2019
Closed
2 tasks
@josibake
Copy link
Author

Including Timedelta and NaT class. These all have to go together due to a matching docstrings constraint

@josibake josibake changed the title DOCS: Fix Docstrings Formatting Error PR09 for pandas.Timestamp class DOCS: fix PR09 doc string errors in Timestamp, NaT, Timedelta class Sep 29, 2019
@josibake josibake changed the title DOCS: fix PR09 doc string errors in Timestamp, NaT, Timedelta class DOCS: fix PR09,PR09 doc string errors in Timestamp, NaT, Timedelta class Sep 30, 2019
josibake pushed a commit to josibake/pandas that referenced this issue Oct 1, 2019
DOC: fix PR09 doc string errors in Timestamp class
59f29e7 
This fixes Parameter {} description should finish with "."
in the Timestamp class

closes pandas-dev#28673
josibake pushed a commit to josibake/pandas that referenced this issue Oct 1, 2019
DOC: fix PR09,PR08 errors for pandas.Timestamp
4af9c62 
this also involves editing the NaT type class
and Timedelta class. this is because there is
a validation which enforces all of these classes
to have the same docstrings

closes pandas-dev#28673
@josibake josibake mentioned this issue Oct 1, 2019
Merged
2 tasks
josibake pushed a commit to josibake/pandas that referenced this issue Oct 4, 2019
DOC: fix PR09,PR08 errors for pandas.Timestamp
c0f99e2 
this also involves editing the NaT type class
and Timedelta class. this is because there is
a validation which enforces all of these classes
to have the same docstrings

closes pandas-dev#28673
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
2 participants
@josibake @simonjayhawkins