DOC: minor enhancement of DataFrame.insert docstring #16341
Merged
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.
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
vsvalue
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 thecol_name
slightly more explicit than justcolumn
, 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).