DOC: update .str.contains/match/startswith docstring examples for default behaviour #61960
+15
−45
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
jorisvandenbossche
added
Docs
Strings
Comment on lines
-1245
to
+1247
| array. For object-dtype, ``numpy.nan`` is used. For the nullable | ||
| ``StringDtype``, ``pandas.NA`` is used. For the ``"str"`` dtype, | ||
| ``False`` is used. | ||
| array. For the ``"str"`` dtype, ``False`` is used. For object | ||
| dtype, ``numpy.nan`` is used. For the nullable ``StringDtype``, | ||
| ``pandas.NA`` is used. |
There was a problem hiding this comment.
Here I am just changing the order to list the default str dtype first
5 tasks
mroeschke
approved these changes
Jul 28, 2025
|
Thanks @jorisvandenbossche |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updating the docstrings of
.str.predicate methods that have thenakeyword.For the examples, the current text is no longer correct (because the default behaviour with str dtype is now to already return False).
For now I just removed those examples. I could instead update the example to create an object-dtype Series to still show the
nabehaviour, but personally I feel that would make the docstring examples more complex than needed, and that it is fine to let they focus on just the default dtype. But no strong opinion ;)