Skip to content

DOC: standardizing docstrings to use pd.DataFrame #18788

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

Merged
merged 2 commits into from
Dec 16, 2017

Conversation

accraze
Copy link
Contributor

@accraze accraze commented Dec 15, 2017

@codecov
Copy link

codecov bot commented Dec 15, 2017

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #18788      +/-   ##
==========================================
- Coverage   91.63%   91.62%   -0.02%     
==========================================
  Files         154      154              
  Lines       51419    51428       +9     
==========================================
  Hits        47120    47120              
- Misses       4299     4308       +9
Flag Coverage Δ
#multiple 89.49% <ø> (ø) ⬆️
#single 40.83% <ø> (-0.11%) ⬇️
Impacted Files Coverage Δ
pandas/core/frame.py 97.68% <ø> (-0.11%) ⬇️
pandas/io/gbq.py 25% <0%> (-58.34%) ⬇️
pandas/core/generic.py 95.9% <0%> (ø) ⬆️
pandas/core/indexes/interval.py 93.83% <0%> (+0.03%) ⬆️
pandas/util/_test_decorators.py 94.54% <0%> (+0.66%) ⬆️

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 7b4229a...71fd9ee. Read the comment docs.

@gfyoung gfyoung added the Docs label Dec 15, 2017
@@ -3780,7 +3780,7 @@ def nlargest(self, n, columns, keep='first'):

Examples
--------
>>> df = DataFrame({'a': [1, 10, 8, 11, -1],
>>> df = pd.DataFrame({'a': [1, 10, 8, 11, -1],
... 'b': list('abdce'),
Copy link
Member

@gfyoung gfyoung Dec 15, 2017

Choose a reason for hiding this comment

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

Although this won't fail, but style-wise, notice how the "a", "b", and "c" rows are aligned and start at that same location on their respective lines. Let's keep it that way (i.e. adjust the "b" and "c" rows).

Copy link
Member

Choose a reason for hiding this comment

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

Follow this comment for one of your other fixes down below (the "column=['a', 'b']").

@jorisvandenbossche jorisvandenbossche merged commit b5f1e71 into pandas-dev:master Dec 16, 2017
@jorisvandenbossche jorisvandenbossche added this to the 0.22.0 milestone Dec 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Standardize docstrings to use pd.DataFrame/pd.Series
3 participants