DOC: Document that info() handles array instances.#23355
Merged
seberg merged 2 commits intonumpy:mainfrom Mar 7, 2023
Merged
Conversation
[skip actions] [skip travis] [skip azp] [skip cirrus]
Member
Author
|
The updated docstring rendered on CircleCI: numpy.info |
mhvk
reviewed
Mar 7, 2023
Contributor
mhvk
left a comment
There was a problem hiding this comment.
Nice! I would suggest to also add array to the top line of the docstring (l. 531), perhaps even as the first item:
Get help information for an array, function, class, or module.
[skip actions] [skip travis] [skip azp] [skip cirrus]
Member
Author
|
@mhvk, good idea, done. |
Member
|
Looks good to me also, thanks! Can't say I have ever used |
Member
|
The CI skips prevented the refguide check from running. That is failing now unfortuntely, since the pointers will vary. |
Member
Author
|
Ah, right. #23359 should fix it. |
Member
Seems that whenever I do that the documents will fail :) |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See #23245.