Skip to content

DOC: Document that info() handles array instances. #23355

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 7, 2023
Merged

DOC: Document that info() handles array instances. #23355

merged 2 commits into from
Mar 7, 2023

Conversation

WarrenWeckesser
Copy link
Member

See #23245.

@WarrenWeckesser
DOC: Document that info() handles array instances.
d559513 
[skip actions] [skip travis] [skip azp] [skip cirrus]
@WarrenWeckesser
Copy link
Member Author

The updated docstring rendered on CircleCI: numpy.info

mhvk
mhvk reviewed Mar 7, 2023
View reviewed changes
Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@WarrenWeckesser
DOC: Edit top line of info() docstring to mention array.
3b57b32 
[skip actions] [skip travis] [skip azp] [skip cirrus]
@WarrenWeckesser
Copy link
Member Author

@mhvk, good idea, done.

mhvk
mhvk approved these changes Mar 7, 2023
View reviewed changes
Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good!

@seberg
Copy link
Member

seberg commented Mar 7, 2023

Looks good to me also, thanks! Can't say I have ever used info either for this or for the doc searching (I do wonder a bit if the latter is really still relevant, but doesn't really matter).

@seberg seberg merged commit b6d372c into numpy:main Mar 7, 2023
@WarrenWeckesser WarrenWeckesser deleted the doc-info branch March 7, 2023 19:54
@seberg
Copy link
Member

seberg commented Mar 7, 2023

The CI skips prevented the refguide check from running. That is failing now unfortuntely, since the pointers will vary.

@WarrenWeckesser
Copy link
Member Author

Ah, right. #23359 should fix it.

@charris
Copy link
Member

charris commented Mar 7, 2023

The CI skips prevented the refguide check from running.

Seems that whenever I do that the documents will fail :)

@WarrenWeckesser WarrenWeckesser mentioned this pull request Jul 8, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mhvk mhvk mhvk approved these changes

Assignees
No one assigned
Labels
04 - Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@WarrenWeckesser @seberg @charris @mhvk