8000 DOC: standardize capitalization of NEP headings (#25060) · numpy/numpy@8568549 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8568549

Browse files
mdhabermdhaber
authored
DOC: standardize capitalization of NEP headings (#25060)
More toward gh-16261. gh-16261 reported that documentation headings currently have inconsistent capitalization schemes and should be standardized. gh-25016 fixed this for rst files except release notes and NEPS. This PR adjusts the NEPs. The case of 'numpy', 'blas', 'scipy', 'python', 'lapack', 'fortran', 'api', 'pypi', 'cpu', 'abi', 'pr', 'github', 'ssh', 'git', 'f77', 'numba', 'f2py', 'cffi', 'bitgenerator', 'simd', 'swig', 'csv', 'ascii', 'json', 'dataframe', 'ieee', 'matlab', 'pyfort', ' c ', and 'nep' are unchanged. (Perhaps it would be a good idea to check the capitalization of some of these words throughout the documentation, but that is a different issue.)
1 parent 893db31 commit 8568549

Some content is hidden

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

42 files changed

+203
-203
lines changed

‎doc/neps/nep-0000.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ There are three kinds of NEPs:
5454
Any meta-NEP is also considered a Process NEP.
5555

5656

57-
NEP Workflow
57+
NEP workflow
5858
------------
5959

6060
The NEP process begins with a new idea for NumPy. It is highly
@@ -97,7 +97,7 @@ to be made available as PR to the NumPy repo (making sure to appropriately
9797
mark the PR as a WIP).
9898

9999

100-
Review and Resolution
100+
Review and resolution
101101
^^^^^^^^^^^^^^^^^^^^^
102102

103103
NEPs are discussed on the mailing list. The possible paths of the
@@ -152,7 +152,7 @@ Process NEPs may also have a status of ``Active`` if they are never
152152
meant to be completed, e.g. NEP 0 (this NEP).
153153

154154

155-
How a NEP becomes Accepted
155+
How a NEP becomes accepted
156156
^^^^^^^^^^^^^^^^^^^^^^^^^^
157157

158158
A NEP is ``Accepted`` by consensus of all interested contributors. We
@@ -220,7 +220,7 @@ to development practices and other details. The precise process followed in
220220
these cases will depend on the nature and purpose of the NEP being updated.
221221

222222

223-
Format and Template
223+
Format and template
224224
-------------------
225225

226226
NEPs are UTF-8 encoded text files using the reStructuredText_ format. Please
@@ -273,7 +273,7 @@ Discussion
273273
- https://mail.python.org/pipermail/numpy-discussion/2017-December/077481.html
274274

275275

276-
References and Footnotes
276+
References and footnotes
277277
------------------------
278278

279279
.. [1] This historical record is available by the normal git commands

‎doc/neps/nep-0001-npy-format.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ more complicated problems for which more complicated formats like
5353
HDF5 [2] are a better solution.
5454

5555

56-
Use Cases
56+
Use cases
5757
---------
5858

5959
- Neville Newbie has just started to pick up Python and NumPy. He
@@ -152,7 +152,7 @@ The format explicitly *does not* need to:
152152
general NPY format.
153153

154154

155-
Format Specification: Version 1.0
155+
Format specification: version 1.0
156156
---------------------------------
157157

158158
The first 6 bytes are a magic string: exactly "\x93NUMPY".
@@ -200,7 +200,7 @@ bytes of the array. Consumers can figure out the number of bytes
200200
by multiplying the number of elements given by the shape (noting
201201
that shape=() means there is 1 element) by dtype.itemsize.
202202

203-
Format Specification: Version 2.0
203+
Format specification: version 2.0
204204
---------------------------------
205205

206206
The version 1.0 format only allowed the array header to have a

‎doc/neps/nep-0002-warnfix.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ the compilers do not generate warnings in those cases; the tag process has to
4444
be clean, readable, and be robust. In particular, it should not make the code
4545
more obscure or worse, break working code.
4646
47-
unused parameter
47+
Unused parameter
4848
----------------
4949
5050
This one appears often: any python-callable C function takes two arguments,
@@ -78,12 +78,12 @@ expanded to::
7878
Thus avoiding any accidental use of the variable. The mangling is pure C, and
7979
thus portable. The per-variable warning disabling is compiler specific.
8080
F438
81-
signed/unsigned comparison
81+
Signed/unsigned comparison
8282
--------------------------
8383
8484
More tricky: not always clear what to do
8585
86-
half-initialized structures
86+
Half-initialized structures
8787
---------------------------
8888
8989
Just put the elements with NULL in it.

‎doc/neps/nep-0005-generalized-ufuncs.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _NEP05:
22

33
=======================================
4-
NEP 5 — Generalized Universal Functions
4+
NEP 5 — Generalized universal functions
55
=======================================
66

77
:Status: Final
@@ -86,7 +86,7 @@ Dimension Index
8686
occurrence of each name in the signature.
8787

8888

89-
Details of Signature
89+
Details of signature
9090
--------------------
9191

9292
The signature defines "core" dimensionality of input and output
@@ -141,7 +141,7 @@ Here are some examples of signatures:
141141
| | | and loop/broadcast over the rest. |
142142
+-------------+------------------------+-----------------------------------+
143143

144-
C-API for implementing Elementary Functions
144+
C-API for implementing elementary functions
145145
-------------------------------------------
146146

147147
The current interface remains unchanged, and ``PyUFunc_FromFuncAndData``
< 10000 code class="diff-text-cell hunk">

‎doc/neps/nep-0006-newbugtracker.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ current trac limitations, and what can be done about it.
1515
Scenario
1616
========
1717

18-
new release
18+
New release
1919
-----------
2020

2121
The workflow for a release is roughly as follows:
@@ -47,7 +47,7 @@ better than the actually deployed version on scipy website. Finding issues with
4747
patches, old patches, etc... and making reports has to be much more streamlined
4848
that it is now.
4949

50-
subcomponent maintainer
50+
Subcomponent maintainer
5151
-----------------------
5252

5353
Say you are the maintainer of scipy.foo, then you are mostly interested in

‎doc/neps/nep-0007-datetime-proposal.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,7 @@ There is a new ufunc C-API call to set the data for a particular
600600
function pointer (for a particular set of data-types) to be the list of arrays
601601
passed in to the ufunc.
602602

603-
Array Interface Extensions
603+
Array interface extensions
604604
--------------------------
605605

606606
The array interface is extended to both handle datetime and timedelta

‎doc/neps/nep-0008-groupby_additions.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _NEP08:
22

3-
=============================================================
4-
NEP 8 — A proposal for adding groupby functionality to NumPy
5-
=============================================================
3+
============================================================
4+
NEP 8 — A proposal for adding groupby functionality to NumPy
5+
============================================================
66

77
:Author: Travis Oliphant
88
:Contact: oliphant@enthought.com
@@ -21,7 +21,7 @@ describes two additional methods for ufuncs (reduceby and reducein) and
2121
two additional functions (segment and edges) which can help add this
2222
functionality.
2323

24-
Example Use Case
24+
Example use case
2525
================
2626
Suppose you have a NumPy structured array containing information about
2727
the number of purchases at several stores over multiple days. To be clear, the

‎doc/neps/nep-0010-new-iterator-ufunc.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _NEP10:
22

33
==============================================
4-
NEP 10 — Optimizing Iterator/UFunc performance
4+
NEP 10 — Optimizing iterator/UFunc performance
55
==============================================
66

77
:Author: Mark Wiebe <mwwiebe@gmail.com>
@@ -75,7 +75,7 @@ a view of the memory, adding, then reshaping back. To further examine
7575
the problem and see how it isn’t always as trivial to work around,
7676
let’s consider simple code for working with image buffers in NumPy.
7777

78-
Image Compositing Example
78+
Image compositing example
7979
=========================
8080

8181
For a more realistic example, consider an image buffer. Images are
@@ -164,7 +164,7 @@ proposed can produce, go to the example continued after the
164164
proposed API, near the bottom of the document.
165165

166166
*************************
167-
Improving Cache-Coherency
167+
Improving cache-coherency
168168
*************************
169169

170170
In order to get the best performance from UFunc calls, the pattern of
@@ -241,7 +241,7 @@ by adding an additional constraint. I think the appropriate choice
241241
is to resolve it by picking the memory layout closest to C-contiguous,
242242
but still compatible with the input strides.
243243

244-
Output Layout Selection Algorithm
244+
Output layout selection algorithm
245245
=================================
246246

247247
The output ndarray memory layout we would like to produce is as follows:
@@ -296,7 +296,7 @@ output layout.::
296296
return perm
297297

298298
*********************
299-
Coalescing Dimensions
299+
Coalescing dimensions
300300
*********************
301301

302302
In many cases, the memory layout allows for the use of a one-dimensional
@@ -334,7 +334,7 @@ Here is pseudo-code for coalescing.::
334334
j += 1
335335

336336
*************************
337-
Inner Loop Specialization
337+
Inner loop specialization
338338
*************************
339339

340340
Specialization is handled purely by the inner loop function, so this
@@ -371,7 +371,7 @@ constant argument may be combined with SSE when the strides match the
371371
data type size, and reductions can be optimized with SSE as well.
372372

373373
**********************
374-
Implementation Details
374+
Implementation details
375375
**********************
376376

377377
Except for inner loop specialization, the discussed
@@ -436,7 +436,7 @@ could adopt this enum as its preferred way of dealing with casting.
436436
NPY_UNSAFE_CASTING=4
437437
} NPY_CASTING;
438438
439-
Iterator Rewrite
439+
Iterator rewrite
440440
================
441441

442442
Based on an analysis of the code, it appears that refactoring the existing
@@ -495,7 +495,7 @@ Notes for implementation:
495495
a wrapper around the C iterator. This is analogous to the
496496
PEP 3118 design separation of Py_buffer and memoryview.
497497

498-
Proposed Iterator Memory Layout
498+
Proposed iterator memory layout
499499
===============================
500500

501501
The following struct describes the iterator memory. All items
@@ -596,7 +596,7 @@ common properties are, resulting in increased cache coherency.
596596
It also simplifies the iternext call, while making getcoord and
597597
related functions slightly more complicated.
598598

599-
Proposed Iterator API
599+
Proposed iterator API
600600
=====================
601601

602602
The existing iterator API includes functions like PyArrayIter_Check,
@@ -631,7 +631,7 @@ to emulate UFunc behavior in cases which don't quite fit the
631631
UFunc paradigm. In particular, emulating the UFunc buffering behavior
632632
is not a trivial enterprise.
633633

634-
Old -> New Iterator API Conversion
634+
Old -> new iterator API conversion
635635
----------------------------------
636636

637637
For the regular iterator:
@@ -672,7 +672,7 @@ For other API calls:
672672
=============================== =============================================
673673

674674

675-
Iterator Pointer Type
675+
Iterator pointer type
676676
---------------------
677677

678678
The iterator structure is internally generated, but a type is still needed
@@ -682,7 +682,7 @@ the API. We do this with a typedef of an incomplete struct
682682
``typedef struct NpyIter_InternalOnly NpyIter;``
683683

684684

685-
Construction and Destruction
685+
Construction and destruction
686686
----------------------------
687687

688688
``NpyIter* NpyIter_New(PyArrayObject* op, npy_uint32 flags, NPY_ORDER order, NPY_CASTING casting, PyArray_Descr* dtype, npy_intp a_ndim, npy_intp *axes, npy_intp buffersize)``
@@ -1415,7 +1415,7 @@ Construction and Destruction
14151415
Fills ``niter`` flags. Sets ``outwriteflags[i]`` to 1 if
14161416
``op[i]`` can be written to, and to 0 if not.
14171417

1418-
Functions For Iteration
1418+
Functions for iteration
14191419
-----------------------
14201420

14211421
``NpyIter_IterNext_Fn NpyIter_GetIterNext(NpyIter *iter, char **errmsg)``
@@ -1680,7 +1680,7 @@ references, and add ``NPY_ITER_WRITEABLE_REFERENCES`` to the flags:
16801680
return ret;
16811681
}
16821682
1683-
Python Lambda UFunc Example
1683+
Python lambda UFunc example
16841684
---------------------------
16851685

16861686
To show how the new iterator allows the definition of efficient UFunc-like
@@ -1733,7 +1733,7 @@ can gain some performance from better cache behavior.::
17331733
Out[7]: True
17341734

17351735

1736-
Python Addition Example
1736+
Python addition example
17371737
-----------------------
17381738

17391739
The iterator has been mostly written and exposed to Python. To
@@ -1897,7 +1897,7 @@ Also, just to check that it's doing the same thing,::
18971897

18981898
Out[22]: True
18991899

1900-
Image Compositing Example Revisited
1900+
Image compositing example revisited
19011901
-----------------------------------
19021902

19031903
For motivation, we had an example that did an 'over' composite operation
@@ -1983,7 +1983,7 @@ functions.::
19831983
...: composite_over_it(image1, image2))
19841984
Out[18]: True
19851985

1986-
Image Compositing With NumExpr
1986+
Image compositing with NumExpr
19871987
------------------------------
19881988

19891989
As a test of the iterator, numexpr has been enhanced to allow use of

‎doc/neps/nep-0011-deferred-ufunc-evaluation.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ UFunc to evaluate on the fly.
7373

7474

7575
*******************
76-
Example Python Code
76+
Example Python code
7777
*******************
7878

7979
Here's how it might be used in NumPy.::
@@ -138,7 +138,7 @@ divide by zero error?" can hopefully be avoided by recommending
138138
this approach.
139139

140140
********************************
141-
Proposed Deferred Evaluation API
141+
Proposed deferred evaluation API
142142
********************************
143143

144144
For deferred evaluation to work, the C API needs to be aware of its
@@ -216,7 +216,7 @@ The Python API would be expanded as follows.
216216
``numpy.errstate``.
217217

218218

219-
Error Handling
219+
Error handling
220220
==============
221221

222222
Error handling is a thorny issue for deferred evaluation. If the
@@ -232,7 +232,7 @@ only when the error state is set to ignore all, but allow user control with
232232
use deferred evaluation, False would mean never use it, and None would
233233
mean use it only when safe (i.e. the error state is set to ignore all).
234234

235-
Interaction With UPDATEIFCOPY
235+
Interaction with UPDATEIFCOPY
236236
=============================
237237

238238
The ``NPY_UPDATEIFCOPY`` documentation states:
@@ -272,7 +272,7 @@ To deal with this issue, we make these two states mutually exclusive.
272272
future. If the deferred evaluation mechanism sees this flag in
273273
any operand, it triggers immediate evaluation.
274274

275-
Other Implementation Details
275+
Other implementation details
276276
============================
277277

278278
When a deferred array is created, it gets references to all the
@@ -288,7 +288,7 @@ This may release references to other deferred arrays contained
288288
in the deferred expression tree, which then
289289
never have to be calculated.
290290

291-
Further Optimization
291+
Further optimization
292292
====================
293293

294294
Instead of conservatively disabling deferred evaluation when any

0 commit comments

Comments
 (0)
0