-
-
Notifications
You must be signed in to change notification settings - Fork 19.2k
DOC: clean up some doc-build warnings #12579
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
Conversation
pandas/core/frame.py
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so @jorisvandenbossche all of those nasty warnings just needed a blank line before AND after a list when embedded in a doc-string. very confusing message
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, indeed, that's the rule for rst lists and also apply in docstrings, unless it's the only thing in the explanation of a parameter (no text before or after in the entry), then no blank lines are needed (eg in this case it is normally not needed)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok I fixed, but that seems a confusing rule. better to just put blanks around lists in doc-strings always, no? (checking if taking these out still has warnings). I was trying things so didn't always take out the added whitespace.
|
only big ones left are these and one on |
pandas/core/generic.py
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the list above, the extra indentation for the list is also not needed
|
On the |
1a3bc1e to
d4f6d95
Compare
|
merged via fcab956 |
No description provided.