Skip to content

DOC: Fix the entries of C functions #17549

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 3 commits into from
Oct 13, 2020

Conversation

takanori-pskq
Copy link

Related to #16217, #13114. Separated from #16370.

sphinx 2 doesn't support function-style macro, so basically used function instead. When the type of parameter is unknown, I dealt with them in the same way as PyArray_MAX, PyArray_MIN, ... (doc/source/reference/c-api/array.rst, l.3476).

@@ -46,24 +46,26 @@ Floating point classification
corresponding single and extension precision macro are available with the
suffix F and L.

.. c:function:: int npy_isnan(x)
.. c:var:: x
Copy link
Member

Choose a reason for hiding this comment

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

Also tempting to revert this change too, and save it for the main PR

Copy link
Member

@eric-wieser eric-wieser left a comment

Choose a reason for hiding this comment

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

Looks good, just one more stray var to clean up so we don't get weird docs like

https://numpy.org/devdocs/reference/c-api/array.html#c.a

@eric-wieser eric-wieser merged commit 18da0ef into numpy:master Oct 13, 2020
@takanori-pskq takanori-pskq deleted the i16217-function-directive branch October 13, 2020 15:13
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.

2 participants