DOC: clean up some doc-build warnings #12579
Conversation
| If ``q`` is a float, a Series will be returned where the | ||
| index is the columns of self and the values are the quantiles. | ||
|
|
||
| - If ``q`` is an array, a DataFrame will be returned where the |
There was a problem hiding this comment.
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.
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.
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 |
| * default: don't fill gaps | ||
| * pad / ffill: propagate last valid observation forward to next | ||
| valid | ||
| * backfill / bfill: use next valid observation to fill gap | ||
| * nearest: use nearest valid observations to fill gap | ||
|
|
There was a problem hiding this comment.
In the list above, the extra indentation for the list is also not needed
|
On the |
jreback
force-pushed
the
docs
branch
2 times, most recently
from
1a3bc1e to
d4f6d95
Compare
|
merged via fcab956 |
No description provided.