Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Fix numpydoc section underlines #60630

Merged
merged 1 commit into from
Dec 30, 2024
Merged

Conversation

mroeschke
Copy link
Member

e.g

/home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpydoc/docscrape.py:203: UserWarning: potentially wrong underline length... 
Returns 
-------- in 

Return utc offset.... in the docstring of utcoffset
  while not self._is_at_section() and not self._doc.eof():
/home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpydoc/docscrape.py:203: UserWarning: potentially wrong underline length... 
Examples 
------------ in 

Check whether all characters in each string are titlecase.... in the docstring of istitle in /home/runner/work/pandas/pandas/pandas/core/strings/accessor.py.
  while not self._is_at_section() and not self._doc.eof():

@mroeschke mroeschke added the Docs label Dec 30, 2024
@mroeschke mroeschke added this to the 3.0 milestone Dec 30, 2024
@mroeschke
Copy link
Member Author

Doc checks are passing so merging

@mroeschke mroeschke merged commit a8a84c8 into pandas-dev:main Dec 30, 2024
50 of 55 checks passed
@mroeschke mroeschke deleted the doc/format branch December 30, 2024 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant