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: fix typos and rearrange CI #25962

Merged
merged 2 commits into from
Mar 8, 2024
Merged

DOC: fix typos and rearrange CI #25962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41fbab2
CI: delay doctests so we still get artifacts
mattip Mar 8, 2024
5b6bc7f
DOC: fix typos [skip actions][skip azp][skip cirrus]
mattip Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions .circleci/config.yml
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading