DOC: Fix warnings on underline length #46215
Merged
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
In https://github.com/pandas-dev/pandas/runs/5413504567?check_suite_focus=true I noticed a few warnings such as ``` /home/runner/miniconda3/envs/pandas-dev/lib/python3.8/site-packages/numpydoc/docscrape.py:434: UserWarning: potentially wrong underline length... Methods ---------- in Immutable sequence used for indexing and alignment. The basic object storing axis labels for all pandas objects. Int64Index is a special case... in the docstring of Int64Index in /home/runner/work/pandas/pandas/pandas/core/indexes/numeric.py. ``` So these were trivial enough to clean up
|
The ASV check failed because of #46193, this change is innocent. |
|
thanks @NickCrews |
NickCrews
added a commit
to NickCrews/pandas
that referenced
this pull request
Mar 4, 2022
I missed the other instance of the problem in pandas-dev#46215.
4 tasks
mroeschke
pushed a commit
that referenced
this pull request
Mar 4, 2022
I missed the other instance of the problem in #46215.
yehoshuadimarsky
pushed a commit
to yehoshuadimarsky/pandas
that referenced
this pull request
Jul 13, 2022
yehoshuadimarsky
pushed a commit
to yehoshuadimarsky/pandas
that referenced
this pull request
Jul 13, 2022
I missed the other instance of the problem in pandas-dev#46215.
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.
In the CI run
https://github.com/pandas-dev/pandas/runs/5413504567?check_suite_focus=true
I noticed a few warnings when building the docs such as
So these were trivial enough to clean up
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.