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.

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

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

Merged
merged 2 commits into from Oct 10, 2021
Merged

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

merged 2 commits into from Oct 10, 2021

Commits on Oct 10, 2021

  1. DOC: Ensure that we add documentation also as to the dict for types 

    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
    @seberg @charris
    seberg authored and charris committed Oct 10, 2021
    Copy the full SHA
    2144b1c View commit details
    Browse the repository at this point in the history

  2. Apply suggestions from code review 

    Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
    @seberg @WarrenWeckesser @charris
    2 people authored and charris committed Oct 10, 2021
    Copy the full SHA
    8f0c4b0 View commit details
    Browse the repository at this point in the history