disambiguate documentation for pandas.Series replace #44130
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.
Currently, the
pandas.Series
that is used for the example forpandas.Series.replace
has an index which is identical to its values (i.e.pandas.Series([0, 1, 2, 3, 4])
). This can be quite confusing at a first glance (as it was for me), as I assumed thatpandas.Series.replace
was using the index of the series (whereas it is actually using the values). Updated the documentation to usepandas.Series([1, 2, 3, 4, 5])
to remove this ambiguity.