-
-
Notifications
You must be signed in to change notification settings - Fork 18.1k
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
DOC: fix punctuation in Timestamp/Timedelta docstrings #28053
Merged
jorisvandenbossche
merged 10 commits into
pandas-dev:master
from
sparalic:Timestamp-Timedelta
Sep 28, 2019
Merged
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
02c7720
Add punctuation to IntervalArray docstrings
sparalic 2924cc5
Merge remote-tracking branch 'upstream/master' into Interval-array
sparalic 6f5cc3f
Revert "Add punctuation to IntervalArray docstrings"
sparalic e9dd483
Add punctuation to Timestamp and Timedelta docstring
sparalic 7807c63
merge upstream
sparalic 1501818
add punctuation to docstrings
sparalic 968b59f
fix errors in test_nat docstrings
sparalic 6c023b0
add period to nattype round docstring
sparalic 212c919
add periods to NaT methods that overlapped with Timestamp
sparalic a9832cb
remove extra period in Timestamp.replace return docstring
sparalic File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@datapythonista I'm never sure what to do with URLs at the end of a sentence. Has this been discussed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jbrockmendel I wasn't sure either, but this seem to have trigger the error for the
Timedelta.isoformat
docstring.@datapythonista updated my branch and the CI still failed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sparalic can you build the html page of that docstring? IIRC you can build that page only with
./doc/make.py --single=pandas.Timedelta.isoformat
(building all the docs takes some time). This way we can see if the dot is added to the url link and breaks it, or if Sphinx is smart enough and does what we want.Looks like there are tests that check those docstrings, you'll have to update them to pass the CI. Let me know if you need help finding the errors in the CI logs...
Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@datapythonista I was able to sucessfylly build the html page for
Timedelta.isoformat
without any warnings. So it seems like Sphinx was smart enough to ignore the period on the end.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you open it with a browser, and paste here a screenshot? I don't think Sphinx will warn, it could just create a link with the period in it, that is broken.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link is created correctly.