Skip to content
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: minor enhancement of DataFrame.insert docstring #16341

Merged
merged 2 commits into from
May 18, 2017

Conversation

pierre-haessig
Copy link
Contributor

  • passes git diff upstream/master --name-only -- '*.py' | flake8 --diff (but not clear to me if I did properly, because the first of the pipe only reports the filename of the changed file, no actual diff.)

My first objective was to clarify the role of column vs value keyword.

For the reference, this is how this function is documented on http://stackoverflow.com/a/18674915/2822346. Function call is presented as df.insert(idx, col_name, value). I find the col_name slightly more explicit than just column, which is ambiguous (i.e. "does column holds the Series?"). But of course this name cannot change without breaking the API. So this small PR is just an attempt to clarify things.

Since I was touching the docstring, I've also make it a bit more tidy (e.g. removed a too long line).

@jorisvandenbossche jorisvandenbossche changed the title minor enhancement of DataFrame.insert docstring DOC: minor enhancement of DataFrame.insert docstring May 12, 2017
@jorisvandenbossche jorisvandenbossche added this to the 0.21.0 milestone May 12, 2017
@jorisvandenbossche
Copy link
Member

The changes look good to me (thanks!), but it seems you have a conflict with master. Can you rebase?

@pierre-haessig
Copy link
Contributor Author

Done! It what quite painful for just a few changed lines, but I think it's ok now. I've pulled the latest master.

@codecov
Copy link

codecov bot commented May 18, 2017

Codecov Report

❗ No coverage uploaded for pull request base (master@539de79). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master   #16341   +/-   ##
=========================================
  Coverage          ?   90.37%           
=========================================
  Files             ?      161           
  Lines             ?    50967           
  Branches          ?        0           
=========================================
  Hits              ?    46063           
  Misses            ?     4904           
  Partials          ?        0
Flag Coverage Δ
#multiple 88.15% <ø> (?)
#single 40.2% <ø> (?)
Impacted Files Coverage Δ
pandas/core/frame.py 97.69% <ø> (ø)

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 539de79...3090f1f. Read the comment docs.

@codecov
Copy link

codecov bot commented May 18, 2017

Codecov Report

❗ No coverage uploaded for pull request base (master@539de79). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master   #16341   +/-   ##
=========================================
  Coverage          ?   90.37%           
=========================================
  Files             ?      161           
  Lines             ?    50967           
  Branches          ?        0           
=========================================
  Hits              ?    46063           
  Misses            ?     4904           
  Partials          ?        0
Flag Coverage Δ
#multiple 88.15% <ø> (?)
#single 40.2% <ø> (?)
Impacted Files Coverage Δ
pandas/core/frame.py 97.69% <ø> (ø)

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 539de79...3090f1f. Read the comment docs.

@jorisvandenbossche jorisvandenbossche merged commit bd300e4 into pandas-dev:master May 18, 2017
@jorisvandenbossche
Copy link
Member

@pierre-haessig Thanks!

pcluo pushed a commit to pcluo/pandas that referenced this pull request May 22, 2017
stangirala pushed a commit to stangirala/pandas that referenced this pull request Jun 11, 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.

2 participants