Skip to content

Commit

Permalink
Merge pull request #25962 from mattip/doc-fixes
Browse files Browse the repository at this point in the history
DOC: fix typos and rearrange CI
  • Loading branch information
seberg committed Mar 8, 2024
2 parents 3d4aed3 + 5b6bc7f commit 030d72b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
20 changes: 10 additions & 10 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,6 @@ jobs:
towncrier build --version $VERSION --yes
./tools/ci/test_all_newsfragments_used.py
- run:
name: run doctests on documentation
command: |
. venv/bin/activate
# Note: keep these two checks separate, because they seem to
# influence each other through changing global state (e.g., via
# `np.polynomial.set_default_printstyle`)
python tools/refguide_check.py --rst
python tools/refguide_check.py --doctests
- run:
name: build devdocs w/ref warnings
command: |
Expand All @@ -104,6 +94,16 @@ jobs:
path: doc/neps/_build/html/
# destination: neps

- run:
name: run doctests on documentation
command: |
. venv/bin/activate
# Note: keep these two checks separate, because they seem to
# influence each other through changing global state (e.g., via
# `np.polynomial.set_default_printstyle`)
python tools/refguide_check.py --rst
python tools/refguide_check.py --doctests
- persist_to_workspace:
root: ~/repo
paths:
Expand Down
1 change: 1 addition & 0 deletions doc/source/numpy_2_0_migration_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ dtype/descriptor itself is attached to an array (e.g. ``arr->descr->elsize``)
this is best replaced with ``PyArray_ITEMSIZE(arr)``.

Where not possible, new accessor functions are required:

* ``PyDataType_ELSIZE`` and ``PyDataType_SET_ELSIZE`` (note that the result
is now ``npy_intp`` and not ``int``).
* ``PyDataType_ALIGNENT``
Expand Down
4 changes: 2 additions & 2 deletions doc/source/reference/c-api/array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ and its sub-types).
success.
.. note::
In general, prefer the use of :c:function:`PyArray_Pack` when
In general, prefer the use of :c:func:`PyArray_Pack` when
handling arbitrary Python objects. Setitem is for example not able
to handle arbitrary casts between different dtypes.
Expand Down Expand Up @@ -781,7 +781,7 @@ cannot not be accessed directly.
.. versionchanged:: 2.0
Prior to NumPy 2.0 the ABI was different but unnecessary large for user
DTypes. These accessors were all added in 2.0 and can be backported
(see :ref:`_migration_c_descr`).
(see :ref:`migration_c_descr`).
.. c:function:: npy_intp PyDataType_ELSIZE(PyArray_Descr *descr)
Expand Down

0 comments on commit 030d72b

Please sign in to comment.