Skip to content

DOC: Make _field_accessor manage the docstring format #24099

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 2 commits into from
Dec 5, 2018
Merged

DOC: Make _field_accessor manage the docstring format #24099

merged 2 commits into from
Dec 5, 2018

Conversation

charlesdong1991
Copy link
Member

@charlesdong1991 charlesdong1991 commented Dec 4, 2018 •
edited by datapythonista
Loading

@pep8speaks
Copy link

Hello @charlesdong1991! Thanks for submitting the PR.

datapythonista
datapythonista reviewed Dec 5, 2018
View reviewed changes
pandas/core/arrays/datetimes.py Outdated
"\nThe ordinal day of the year\n")
quarter = _field_accessor('quarter', 'q', "\nThe quarter of the date\n")
"The ordinal day of the year")
quarter = _field_accessor('quarter', 'q', "The quarter of the date")
Copy link
Member

Choose a reason for hiding this comment

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

If you don't mind adding periods at the end of these 3 docstrings, that would be great, so we fix that error too.

Also, if you can merge master, and check that the CI is green, so we can merge.

@codecov
Copy link

codecov bot commented Dec 5, 2018

Codecov Report

Merging #24099 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24099   +/-   ##
=======================================
  Coverage   42.52%   42.52%           
=======================================
  Files         161      161           
  Lines       51697    51697           
=======================================
  Hits        21982    21982           
  Misses      29715    29715
Flag Coverage Δ
#single 42.52% <100%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/arrays/timedeltas.py 38.96% <100%> (ø) ⬆️
pandas/core/arrays/datetimes.py 63.79% <100%> (ø) ⬆️

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 1d3ed91...dc065ad. Read the comment docs.

@codecov
Copy link

codecov bot commented Dec 5, 2018 •
edited
Loading

Codecov Report

Merging #24099 into master will increase coverage by 49.68%.
The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff             @@
##           master   #24099       +/-   ##
===========================================
+ Coverage   42.52%   92.21%   +49.68%     
===========================================
  Files         161      161               
  Lines       51697    51684       -13     
===========================================
+ Hits        21982    47658    +25676     
+ Misses      29715     4026    -25689
Flag Coverage Δ
#multiple 90.61% <100%> (?)
#single 43% <100%> (+0.48%) ⬆️
Impacted Files Coverage Δ
pandas/core/arrays/timedeltas.py 87.61% <100%> (+48.64%) ⬆️
pandas/core/arrays/datetimes.py 98.43% <100%> (+34.63%) ⬆️
pandas/core/computation/pytables.py 92.37% <0%> (+0.3%) ⬆️
pandas/io/pytables.py 92.3% <0%> (+0.92%) ⬆️
pandas/util/_test_decorators.py 93.24% <0%> (+4.05%) ⬆️
pandas/compat/__init__.py 58.36% <0%> (+8.17%) ⬆️
pandas/core/config_init.py 99.24% <0%> (+9.84%) ⬆️
pandas/core/reshape/util.py 100% <0%> (+11.53%) ⬆️
pandas/compat/numpy/__init__.py 92.85% <0%> (+14.28%) ⬆️
pandas/core/computation/common.py 85.71% <0%> (+14.28%) ⬆️
... and 120 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 1d3ed91...dc065ad. Read the comment docs.

datapythonista
datapythonista approved these changes Dec 5, 2018
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

lgtm, thanks @charlesdong1991

@jreback jreback added this to the 0.24.0 milestone Dec 5, 2018
@jreback jreback merged commit 9f2c716 into pandas-dev:master Dec 5, 2018
@jreback
Copy link
Contributor

jreback commented Dec 5, 2018

thanks @charlesdong1991

@datapythonista datapythonista mentioned this pull request Dec 10, 2018
Merged
4 tasks
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
@charlesdong1991 @Pingviinituutti
DOC: Make _field_accessor manage the docstring format (pandas-dev#24099)
e1f9ac4
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
@charlesdong1991 @Pingviinituutti
DOC: Make _field_accessor manage the docstring format (pandas-dev#24099)
a2974e7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista approved these changes

Assignees
No one assigned
Labels
Clean Docs
Projects
None yet
Milestone
0.24.0
Development

Successfully merging this pull request may close these issues.

DOC: Make _field_accessor manage the docstring format
4 participants
@charlesdong1991 @pep8speaks @jreback @datapythonista