Skip to content

DOC: Document the NPY_SCALARKIND values as C variables. #14576

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

Merged
merged 1 commit into from
Sep 25, 2019
Merged

DOC: Document the NPY_SCALARKIND values as C variables. #14576

merged 1 commit into from
Sep 25, 2019

Conversation

MSeifert04
Copy link
Contributor

@MSeifert04 MSeifert04 commented Sep 22, 2019

Currently the ":c:data:" links could not resolve these because the values were not explicitly documented.

Also removes some duplication with the doc of PyArray_ScalarKind.

Current documentation: https://numpy.org/devdocs/reference/c-api/array.html#c.NPY_SCALARKIND

Currently the ":c:data:" links could not resolve these because the
values were not explicitly documented.
@MSeifert04
Copy link
Contributor Author

From my side this is ready for review. This should be rather straight-forward - if the change is desired.

@mattip mattip merged commit 07a5753 into numpy:master Sep 25, 2019
@mattip
Copy link
Member

mattip commented Sep 25, 2019

Thanks @MSeifert04. Note there is a tracking issue to try to turn on -n for sphinx builds, which would expose many of these broken references

@MSeifert04 MSeifert04 deleted the doc-make-NPY_SCALARKIND-linkable branch September 25, 2019 13:59
@MSeifert04
Copy link
Contributor Author

@mattip Thanks for the reference and for the review 👍

Does that mean I shouldn't address single instances and instead bulk-fix certain issues? I'm a bit confused :)

@mattip
Copy link
Member

mattip commented Sep 25, 2019

between fixing all the 1090 remaining bad references in one go and fixing one letter typos is a wide range. This PR is a bit on the small side but OK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants