DOC: Fixed documentation for few files #40903
Conversation
ShaharNaveh
commented
Apr 12, 2021
•
ShaharNaveh
commented
- tests added / passed
- Ensure all linting tests pass, see here for how to run them
pandas/core/indexers.py
Outdated
| ... | ||
| ValueError: negative dimensions are not allowed | ||
|
|
||
| >>> validate_indices(np.ndarray([0, 1]), 0) # OK |
There was a problem hiding this comment.
The docs in master ATM says it should raise an IndexError, but it does not.
Would be glad if someone will take a look here
There was a problem hiding this comment.
Why are you using np.ndarray instead of np.array? The latter one raises
There was a problem hiding this comment.
Why are you using np.ndarray instead of np.array? The latter one raises
I complety missed it, I have pushed a fix for it in 857c110
|
dont' we have a master issue for this? (e.g. getting all doc-tests running)? cc @MarcoGorelli |
I wasn't aware that not all doctests were running - anyway, there's #22459 still open |
ci/code_checks.sh
Outdated
| @@ -138,6 +138,10 @@ if [[ -z "$CHECK" || "$CHECK" == "doctests" ]]; then | |||
|
|
|||
| # Individual files | |||
|
|
|||
| MSG='Doctests algorithms.py' ; echo $MSG | |||
There was a problem hiding this comment.
can these be combined? e.g. 1 for files, 1 for directories
There was a problem hiding this comment.
Sure, will open a separate PR for that.
| ... pd.Timestamp("20160101", tz="US/Eastern"), | ||
| ... ] | ||
| ... ) | ||
| ... ) | ||
| DatetimeIndex(['2016-01-01 00:00:00-05:00'], |
There was a problem hiding this comment.
That's the "Black" formatting.
I personally think it's easier on the eyes, but that's not a deal breaker for me.
Can revert if you think it's best to leave it as it was before
There was a problem hiding this comment.
Sorry if this was misleading, I was referring to the lines you haven‘t touched, they look out of sync now
There was a problem hiding this comment.
I didn't managed to get the output lines to follow the "black" formatting styles.
What I could do is to make the output to appear in a single line, instead of multiple by using \. i.e
def foo():
"""
Examples
--------------
>> foo()
Line1 \
Line 2 \
Line 3 \
"""Will result in the docs as:
>>> foo()
Line 1 Line 2 Line 3
|
small comment, otherwise lgtm |
|
lgtm @phofl over to you |
|
thanks @ShaharNaveh |
Co-authored-by: ShaharNaveh <>
Co-authored-by: ShaharNaveh <>
