Skip to content
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.

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

DOC: Ensure that we add documentation also as to the dict for types #20082

Merged
merged 2 commits into from Oct 10, 2021

Conversation

@charris
Copy link
Member

@charris charris commented Oct 10, 2021

Backport of #19775.

This ensures that help(np.dtype) produces a result. I am not
exactly sure why it picks up __doc__ from the dict instead of
tp_doc right now. It probably is due to the combination of
inheritance and the fact that the dict always includes None
and gets preference during inheritance.
(That probably makes a lot of sense to not inherit the type
docstring by default.)

Modifying the dictionary directly is not really good style, either,
but hopefully works.

Closes gh-18740

seberg and others added 2 commits Oct 10, 2021
This ensures that `help(np.dtype)` produces a result.  I am not
exactly sure why it picks up `__doc__` from the dict instead of
`tp_doc` right now. It probably is due to the combination of
inheritance and the fact that the dict always includes `None`
and gets preference during inheritance.
(That probably makes a lot of sense to not inherit the `type`
docstring by default.)

Modifying the dictionary directly is not really good style, either,
but hopefully works.

Closes numpygh-18740
Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
@charris charris added this to the 1.21.3 release milestone Oct 10, 2021
@charris charris merged commit 707f650 into numpy:maintenance/1.21.x Oct 10, 2021
37 checks passed
Loading
@charris charris deleted the backport-18775 branch Oct 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants