DOC: update the Period.start_time attribute docstring #20325
Merged
Conversation
This file contains hidden or 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
pandas/_libs/tslibs/period.pyx
Outdated
| @@ -1164,6 +1164,36 @@ cdef class _Period(object): | |||
|
|
|||
| @property | |||
| def start_time(self): | |||
| """ | |||
| Return the Timestamp. | |||
There was a problem hiding this comment.
"Get the Timestamp for the start of the period."
pandas/_libs/tslibs/period.pyx
Outdated
| """ | ||
| Return the Timestamp. | ||
|
|
||
| This attribute returns the timestamp of the particular |
There was a problem hiding this comment.
This can be removed I think.
pandas/_libs/tslibs/period.pyx
Outdated
|
|
||
| See also | ||
| -------- | ||
| Period.dayofyear |
There was a problem hiding this comment.
These can be one line each. Period.dayofyear : Return the day of year.
pandas/_libs/tslibs/period.pyx
Outdated
| Period.dayofweek | ||
| Return the day of the week. | ||
|
|
||
| Returns |
There was a problem hiding this comment.
Move returns above See Also
Codecov Report
@@ Coverage Diff @@
## master #20325 +/- ##
==========================================
- Coverage 91.76% 91.73% -0.03%
==========================================
Files 150 150
Lines 49151 49151
==========================================
- Hits 45102 45090 -12
- Misses 4049 4061 +12
Continue to review full report at Codecov.
|
[ci skip]
|
Added end_time to the see also. Thanks @hammadmashkoor . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):
scripts/validate_docstrings.py <your-function-or-method>git diff upstream/master -u -- "*.py" | flake8 --diffpython doc/make.py --single <your-function-or-method>Please include the output of the validation script below between the "```" ticks:
If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.