Skip to content

Commit 66d33fa

Browse files
authored
Merge pull request numpy#19911 from DimitriPapadopoulos/codespell
DOC: Typos found by codespell
2 parents a838abe + 8396026 commit 66d33fa

File tree

94 files changed

+159
-155
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+159
-155
lines changed

doc/preprocess.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def main():
99

1010
def doxy_gen(root_path):
1111
"""
12-
Generate Doxygen configration file.
12+
Generate Doxygen configuration file.
1313
"""
1414
confs = doxy_config(root_path)
1515
build_path = os.path.join(root_path, "doc", "build", "doxygen")

doc/source/dev/development_advanced_debugging.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Advanced debugging tools
33
========================
44

55
If you reached here, you want to dive into, or use, more advanced tooling.
6-
This is usually not necessary for first time contributers and most
7-
day-to-day developement.
6+
This is usually not necessary for first time contributors and most
7+
day-to-day development.
88
These are used more rarely, for example close to a new NumPy release,
99
or when a large or particular complex change was made.
1010

@@ -25,7 +25,7 @@ narrow down.
2525
We do not expect any of these tools to be run by most contributors.
2626
However, you can ensure that we can track down such issues more easily easier:
2727

28-
* Tests should cover all code paths, incluing error paths.
28+
* Tests should cover all code paths, including error paths.
2929
* Try to write short and simple tests. If you have a very complicated test
3030
consider creating an additional simpler test as well.
3131
This can be helpful, because often it is only easy to find which test
@@ -112,7 +112,7 @@ where ``PYTHONMALLOC=malloc`` is necessary to avoid false positives from python
112112
itself.
113113
Depending on the system and valgrind version, you may see more false positives.
114114
``valgrind`` supports "suppressions" to ignore some of these, and Python does
115-
have a supression file (and even a compile time option) which may help if you
115+
have a suppression file (and even a compile time option) which may help if you
116116
find it necessary.
117117

118118
Valgrind helps:

doc/source/dev/development_environment.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ source tree is to use::
122122

123123

124124
NumPy uses a series of tests to probe the compiler and libc libraries for
125-
funtions. The results are stored in ``_numpyconfig.h`` and ``config.h`` files
125+
functions. The results are stored in ``_numpyconfig.h`` and ``config.h`` files
126126
using ``HAVE_XXX`` definitions. These tests are run during the ``build_src``
127127
phase of the ``_multiarray_umath`` module in the ``generate_config_h`` and
128128
``generate_numpyconfig_h`` functions. Since the output of these calls includes

doc/source/dev/howto-docs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ category, but other rewordings -- even for grammar -- require a judgment call,
6060
which raises the bar. Test the waters by first presenting the fix as an issue.
6161

6262
Some functions/objects like numpy.ndarray.transpose, numpy.array etc. defined in
63-
C-extension modules have their docstrings defined seperately in `_add_newdocs.py
63+
C-extension modules have their docstrings defined separately in `_add_newdocs.py
6464
<https://github.com/numpy/numpy/blob/main/numpy/core/_add_newdocs.py>`__
6565

6666
**********************
@@ -72,7 +72,7 @@ Your frustrations using our documents are our best guide to what needs fixing.
7272
If you write a missing doc you join the front line of open source, but it's
7373
a meaningful contribution just to let us know what's missing. If you want to
7474
compose a doc, run your thoughts by the `mailing list
75-
<https://mail.python.org/mailman/listinfo/numpy-discussion>`__ for futher
75+
<https://mail.python.org/mailman/listinfo/numpy-discussion>`__ for further
7676
ideas and feedback. If you want to alert us to a gap,
7777
`open an issue <https://github.com/numpy/numpy/issues>`__. See
7878
`this issue <https://github.com/numpy/numpy/issues/15760>`__ for an example.

doc/source/reference/arrays.scalars.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ are also provided.
399399
complex256
400400

401401
Alias for `numpy.clongdouble`, named after its size in bits.
402-
The existance of these aliases depends on the platform.
402+
The existence of these aliases depends on the platform.
403403

404404
Other aliases
405405
~~~~~~~~~~~~~

doc/source/reference/c-api/iterator.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1230,7 +1230,7 @@ Functions For Iteration
12301230
.. c:function:: npy_intp* NpyIter_GetIndexPtr(NpyIter* iter)
12311231
12321232
This gives back a pointer to the index being tracked, or NULL
1233-
if no index is being tracked. It is only useable if one of
1233+
if no index is being tracked. It is only usable if one of
12341234
the flags :c:data:`NPY_ITER_C_INDEX` or :c:data:`NPY_ITER_F_INDEX`
12351235
were specified during construction.
12361236

doc/source/reference/c-api/types-and-structures.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ PyArray_Type and PyArrayObject
9494
PyArray_Descr *descr;
9595
int flags;
9696
PyObject *weakreflist;
97-
/* version dependend private members */
97+
/* version dependent private members */
9898
} PyArrayObject;
9999
100100
.. c:macro:: PyObject_HEAD
@@ -178,7 +178,7 @@ PyArray_Type and PyArrayObject
178178

179179
.. note::
180180

181-
Further members are considered private and version dependend. If the size
181+
Further members are considered private and version dependent. If the size
182182
of the struct is important for your code, special care must be taken.
183183
A possible use-case when this is relevant is subclassing in C.
184184
If your code relies on ``sizeof(PyArrayObject)`` to be constant,

doc/source/reference/random/bit_generators/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Bit Generators
44
--------------
55

66
The random values produced by :class:`~Generator`
7-
orignate in a BitGenerator. The BitGenerators do not directly provide
7+
originate in a BitGenerator. The BitGenerators do not directly provide
88
random numbers and only contains methods used for seeding, getting or
99
setting the state, jumping or advancing the state, and for accessing
1010
low-level wrappers for consumption by code that can efficiently

doc/source/reference/routines.ma.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -287,11 +287,11 @@ Filling a masked array
287287

288288
_____
289289

290-
Masked arrays arithmetics
291-
=========================
290+
Masked arrays arithmetic
291+
========================
292292

293-
Arithmetics
294-
~~~~~~~~~~~
293+
Arithmetic
294+
~~~~~~~~~~
295295
.. autosummary::
296296
:toctree: generated/
297297

doc/source/reference/routines.polynomials.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Therefore :mod:`numpy.polynomial` is recommended for new coding.
2222
the polynomial functions prefixed with *poly* accessible from the `numpy`
2323
namespace (e.g. `numpy.polyadd`, `numpy.polyval`, `numpy.polyfit`, etc.).
2424

25-
The term *polynomial package* refers to the new API definied in
25+
The term *polynomial package* refers to the new API defined in
2626
`numpy.polynomial`, which includes the convenience classes for the
2727
different kinds of polynomials (`numpy.polynomial.Polynomial`,
2828
`numpy.polynomial.Chebyshev`, etc.).
@@ -110,7 +110,7 @@ See the documentation for the
110110
`convenience classes <routines.polynomials.classes>`_ for further details on
111111
the ``domain`` and ``window`` attributes.
112112

113-
Another major difference bewteen the legacy polynomial module and the
113+
Another major difference between the legacy polynomial module and the
114114
polynomial package is polynomial fitting. In the old module, fitting was
115115
done via the `~numpy.polyfit` function. In the polynomial package, the
116116
`~numpy.polynomial.polynomial.Polynomial.fit` class method is preferred. For

0 commit comments

Comments
 (0)