Skip to content

Conversation

@davidmvalente
Copy link
Contributor

@davidmvalente davidmvalente commented Sep 1, 2018

Deleted the word 'replaced' from the Returns section of the docstring, since it is an unnecessary local variable name.

@davidmvalente davidmvalente changed the title Deleted 'replaced' from Returns docstring DOC: Deleted 'replaced' from Returns docstring Sep 1, 2018
Returns
-------
replaced : Series/Index of objects
Series/Index of objects
Copy link
Member

Choose a reason for hiding this comment

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

I think we usually document this as Series or Index of object (note I also change objects to object).

Also, If you can add a description in the next line, indented with four spaces, explaining what this method returns, that would be great.

@codecov
Copy link

codecov bot commented Sep 1, 2018

Codecov Report

Merging #22563 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #22563   +/-   ##
=======================================
  Coverage   92.04%   92.04%           
=======================================
  Files         169      169           
  Lines       50787    50787           
=======================================
  Hits        46745    46745           
  Misses       4042     4042
Flag Coverage Δ
#multiple 90.45% <ø> (ø) ⬆️
#single 42.29% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/strings.py 98.63% <ø> (ø) ⬆️

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 98fb53c...0c1193a. Read the comment docs.

@gfyoung gfyoung added the Docs label Sep 1, 2018
@datapythonista datapythonista merged commit 62d9f8c into pandas-dev:master Sep 2, 2018
@datapythonista
Copy link
Member

Thanks for the changes @davidmvalente

@datapythonista datapythonista added the Strings String extension data type and string data label Sep 2, 2018
Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Strings String extension data type and string data

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants