REF: Remove dynamic docstrings from option methods #57710
Merged
Conversation
This file contains 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
rhshadrach
reviewed
Mar 5, 2024
Comment on lines
+668
to
+671
| with warnings.catch_warnings(): | ||
| warnings.simplefilter("ignore", FutureWarning) | ||
| warnings.simplefilter("ignore", DeprecationWarning) | ||
| s += f"\n [default: {o.defval}] [currently: {get_option(k)}]" |
There was a problem hiding this comment.
One thing to be aware of is the impact of python/cpython#73858. Once this block is entered, the cache of previously seen warnings is cleared so that users will see any already encountered warning again. If encountered in a for loop this can cause a warning to get printed thousands of times e.g. #57054.
I believe this will only be run on import, so I think this is likely to have almost no impact - in the odd case you import pandas in e.g. a for loop the warning would be seen at most twice because of import caching.
rhshadrach
approved these changes
Mar 5, 2024
5 tasks
|
/preview |
|
Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/57710/ |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
* REF: Remove dynamic docstrings from option methods * Fix arguments * Reuse * Fix drop duplicate section, numpydoc valudation * Fix formatting
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.
xref #57578 (comment)
These methods have complex docstrings in an attempt to display all option within the docstring. This makes these docstrings hard to automatically validate and renders the internal implementation in Sphinx. I think it's reasonable to link to the docs where all the options are listed instead.
Additionally did some cleanups removing
silentfrom some of these methods by instead catching warnings where needed