Skip to content

DOC : Update the pandas.Period.week docstring #20331

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
Merged
merged 4 commits into from
Mar 17, 2018
Merged

DOC : Update the pandas.Period.week docstring #20331

merged 4 commits into from
Mar 17, 2018

Conversation

IHackPy
Copy link
Contributor

@IHackPy IHackPy commented Mar 13, 2018 •
edited by TomAugspurger
Loading 

# Period.week
################################################################################
######################## Docstring (pandas.Period.week) ########################
################################################################################

Get the total weeks on the Period falls in.

Returns
-------
int 

See Also
--------
Period.dayofweek : Get the day component of the Period.
Period.weekday : Get the day component of the Period.

Examples
--------
>>> p = pd.Period("2018-03-11")
>>> p.week
10

################################################################################
################################## Validation ##################################
################################################################################

TomAugspurger
TomAugspurger reviewed Mar 13, 2018
View reviewed changes
pandas/_libs/tslibs/period.pyx Outdated
@@ -1305,6 +1305,24 @@ cdef class _Period(object):

@property
def week(self):
"""
Get the total weeks on the Period falls in.
Copy link
Contributor

@TomAugspurger TomAugspurger Mar 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Total weeks -> "week of the year"?

We'll want to keep an eye on #20324 for this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Get the week of the year on the given Period"?

sure will check #20324

Copy link
Contributor

@TomAugspurger TomAugspurger Mar 16, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you update the summary?

@codecov
Copy link

codecov bot commented Mar 14, 2018 •
edited
Loading

Codecov Report

Merging #20331 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #20331      +/-   ##
==========================================
+ Coverage   91.76%   91.77%   +0.01%     
==========================================
  Files         150      152       +2     
  Lines       49148    49178      +30     
==========================================
+ Hits        45099    45135      +36     
+ Misses       4049     4043       -6
Flag Coverage Δ
#multiple 90.16% <ø> (+0.01%) ⬆️
#single 41.84% <ø> (-0.06%) ⬇️
Impacted Files Coverage Δ
pandas/core/base.py 96.77% <0%> (-0.02%) ⬇️
pandas/core/window.py 96.29% <0%> (-0.02%) ⬇️
pandas/core/series.py 93.84% <0%> (-0.01%) ⬇️
pandas/core/indexes/datetimes.py 95.64% <0%> (ø) ⬆️
pandas/core/generic.py 95.85% <0%> (ø) ⬆️
pandas/plotting/_core.py 82.27% <0%> (ø) ⬆️
pandas/core/indexes/interval.py 93.08% <0%> (ø) ⬆️
pandas/core/indexing.py 93.02% <0%> (ø) ⬆️
pandas/core/indexes/datetimelike.py 96.72% <0%> (ø) ⬆️
pandas/core/strings.py 98.32% <0%> (ø) ⬆️
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c6eec25...52a5b7c. Read the comment docs.

@jorisvandenbossche jorisvandenbossche merged commit 6d20a36 into pandas-dev:master Mar 17, 2018
@jorisvandenbossche
Copy link
Member

@himanshuawasthi95 Thanks!

@jorisvandenbossche jorisvandenbossche added this to the 0.23.0 milestone Mar 17, 2018
@IHackPy
Copy link
Contributor Author

IHackPy commented Mar 17, 2018

thanks @TomAugspurger & @jorisvandenbossche

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAugspurger TomAugspurger TomAugspurger left review comments

@jorisvandenbossche jorisvandenbossche jorisvandenbossche approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
0.23.0
Development

Successfully merging this pull request may close these issues.
3 participants
@IHackPy @jorisvandenbossche @TomAugspurger