DOC: #22266 Add examples for tril_indices_from(), triu_indices_from() #22562
Conversation
|
Thanks. The tests are failing here, so it seems one of the example output is wrong. The lines should also be kept shorter (the linter is unhappy due to this), that probably means a slightly differently formatted output (if the output is always like this, then we can ignore that). |
|
close/reopen |
|
The examples seem to be incorrect, hence the test failures. |
* incides -> indices * Update wording surrounding .
There was a problem hiding this comment.
I took the liberty of pushing up a fix to the failing docstring example. A couple minor subjective comments about potentially shortening things by the calling of other functions from the examples, but that's just an opinion. There's nothing to be done about the failing linter as the line length is dicated by the example output.
I'll put this in once CI passes. Thanks @richierocks !
| This is syntactic sugar for tril_indices(). | ||
|
|
||
| >>> np.tril_indices(a.shape[0]) | ||
| (array([0, 1, 1, 2, 2, 2, 3, 3, 3, 3]), array([0, 0, 1, 0, 1, 2, 0, 1, 2, 3])) | ||
|
|
There was a problem hiding this comment.
I'd prefer to remove this in favor of the See Also reference to tril_indices immediately below the examples, but it's not a blocker.
| This is syntactic sugar for triu_indices(). | ||
|
|
||
| >>> np.triu_indices(a.shape[0]) | ||
| (array([0, 0, 0, 0, 1, 1, 1, 2, 2, 3]), array([0, 1, 2, 3, 1, 2, 3, 2, 3, 3])) | ||
|
|
Add examples for tril_indices_from(), triu_indices_from() as requested by #22266.
Written as part of PyData 2022 sprint.