DOC : Refactor Array API documentation -- Array Structure and Data Access #13892
Conversation
|
Link to the rendered documents |
doc/source/reference/c-api.array.rst
Outdated
| .. versionadded:: 1.7 | ||
|
|
||
| A synonym for PyArray_DIMS, named to be consistent with the | ||
| 'shape' usage within Python. |
There was a problem hiding this comment.
do you need ndarary.shape (single backticks) to turn it into a link?
There was a problem hiding this comment.
Single backticks just make the test italic. For including the link I did something like the recent change :attr:shape <ndarray.shape> as was done in the other document arrays.ndarray.rst but for some reason, that simply made the text bold but did not link it with the attributes' documentation. Doing :ref: doesn't even make the text bold, leave rendering as a link.
There was a problem hiding this comment.
this works for me:
`shape <numpy.ndarray.shape>`
You could avoid the numpy prefix by adding .. currentmodule:: numpy before this
| @@ -75,7 +76,8 @@ PyArray_Type and PyArrayObject | |||
| these structure members should normally be accessed using the | |||
| provided macros. If you need a shorter name, then you can make use | |||
| of :c:type:`NPY_AO` (deprecated) which is defined to be equivalent to | |||
| :c:type:`PyArrayObject`. | |||
| :c:type:`PyArrayObject`. Direct access to the struct fields are | |||
| deprecated `PyArray_*(arr)` form instead. | |||
There was a problem hiding this comment.
missing text. "deprecated. Use the PyArray_*(arr) form instead"
|
Can you remove the WIP? I think his is almost ready to go in |
|
I had kept it WIP as I intended to refactor the whole Array API documentation in this PR after it looks okay to you for the first section (as discussed in the meeting) . What do you suggest, should I open separate PR for the other parts? |
Whatever you prefer. Sometimes it is nice to get the finished things out of the way, especially if it will take a while to get the rest done |
|
Removed the WIP label. The builds are failing due to some container in use issue. Is there something in my pull request which is causing this issue, no, right? |
|
The shippable builds are failing everywhere for us, xref Shippable/support#4882 |
Some code cleanup, ordering and inclusion of missing references in the Array API docs . Work in progress.