DOC: Remove stale Categorical side-effects section #64071
+0
−31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The "Side effects" section under `doc/source/user_guide/categorical.rst` ([pandas docs](https://pandas.pydata.org/docs/user_guide/categorical.html)) warns that constructing a `Series` from a `Categorical` without `copy=True` allows mutations to propagate back to the original `Categorical`. This is no longer true as of pandas 3.0, where Copy-on-Write is the default behavior ([v3.0.0 release notes](https://pandas.pydata.org/docs/whatsnew/v3.0.0.html)). Under CoW, the `Series` constructor always behaves as if it produces a copy, so the side effect described in this section cannot occur. Both code examples in the section already produce identical output, confirming the warning is stale. This PR removes the section entirely.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The "Side effects" section under
doc/source/user_guide/categorical.rst(pandas docs) warns that constructing aSeriesfrom aCategoricalwithoutcopy=Trueallows mutations to propagate back to the originalCategorical. This is no longer true as of pandas 3.0, where Copy-on-Write is the default behavior (v3.0.0 release notes).Under CoW, the
Seriesconstructor always behaves as if it produces a copy, so the side effect described in this section cannot occur. Both code examples in the section already produce identical output, confirming the warning is stale.This PR removes the section entirely.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.AGENTS.md.