8000 DOC: Convert titles to sentence case (#23643) · numpy/numpy@ba529fa · GitHub
[go: up one dir, main page]
Skip to content

Commit ba529fa

Browse files
talhabmtalhabm
authored
DOC: Convert titles to sentence case (#23643)
Partially addresses #16261.
1 parent 5665fdc commit ba529fa

14 files changed

+29
-29
lines changed

‎doc/source/dev/alignment.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
.. _alignment:
44

55
****************
6-
Memory Alignment
6+
Memory alignment
77
****************
88

99
NumPy alignment goals

‎doc/source/dev/gitwash/git_resources.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _git-resources:
22

33
=========================
4-
Additional Git_ Resources
4+
Additional Git_ resources
55
=========================
66

77
Tutorials and summaries

‎doc/source/dev/reviewer_guidelines.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _reviewer-guidelines:
22

33
===================
4-
Reviewer Guidelines
4+
Reviewer guidelines
55
===================
66

77
Reviewing open pull requests (PRs) helps move the project forward. We encourage

‎doc/source/f2py/buildtools/cmake.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ but this `extensive CMake collection`_ of resources is great.
1818
``f2py`` is not particularly native or pleasant; and a more natural approach
1919
is to consider :ref:`f2py-skbuild`
2020

21-
Fibonacci Walkthrough (F77)
21+
Fibonacci walkthrough (F77)
2222
===========================
2323

2424
Returning to the ``fib`` example from :ref:`f2py-getting-started` section.

‎doc/source/reference/arrays.nditer.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
.. _arrays.nditer:
44

55
*********************
6-
Iterating Over Arrays
6+
Iterating over arrays
77
*********************
88

99
.. note::
@@ -23,7 +23,7 @@ can accelerate the inner loop in Cython. Since the Python exposure of
2323
iterator API, these ideas will also provide help working with array
2424
iteration from C or C++.
2525

26-
Single Array Iteration
26+
Single array iteration
2727
======================
2828

2929
The most basic task that can be done with the :class:`nditer` is to
@@ -64,7 +64,7 @@ namely the order they are stored in memory, whereas the elements of
6464
`a.T.copy(order='C')` get visited in a different order because they
6565
have been put into a different memory layout.
6666

67-
Controlling Iteration Order
67+
Controlling iteration order
6868
---------------------------
6969

7070
There are times when it is important to visit the elements of an array
@@ -88,7 +88,7 @@ order='C' for C order and order='F' for Fortran order.
8888

8989
.. _nditer-context-manager:
9090

91-
Modifying Array Values
91+
Modifying array values
9292
----------------------
9393

9494
By default, the :class:`nditer` treats the input operand as a read-only
@@ -128,7 +128,7 @@ note that prior to 1.15, :class:`nditer` was not a context manager and
128128
did not have a `close` method. Instead it relied on the destructor to
129129
initiate the writeback of the buffer.
130130

131-
Using an External Loop
131+
Using an external loop
132132
----------------------
133133

134134
In all the examples so far, the elements of `a` are provided by the
@@ -161,7 +161,7 @@ elements each.
161161
...
162162
[0 3] [1 4] [2 5]
163163

164-
Tracking an Index or Multi-Index
164+
Tracking an index or multi-index
165165
--------------------------------
166166

167167
During iteration, you may want to use the index of the current
@@ -210,7 +210,7 @@ raise an exception.
210210
File "<stdin>", line 1, in <module>
211211
ValueError: Iterator flag EXTERNAL_LOOP cannot be used if an index or multi-index is being tracked
212212

213-
Alternative Looping and Element Access
213+
Alternative looping and element access
214214
--------------------------------------
215215

216216
To make its properties more readily accessible during iteration,
@@ -246,7 +246,7 @@ produce identical results to the ones in the previous section.
246246
array([[ 0, 1, 2],
247247
[-1, 0, 1]])
248248

249-
Buffering the Array Elements
249+
Buffering the array elements
250250
----------------------------
251251

252252
When forcing an iteration order, we observed that the external loop
@@ -274,7 +274,7 @@ is enabled.
274274
...
275275
[0 3 1 4 2 5]
276276

277-
Iterating as a Specific Data Type
277+
Iterating as a specific data type
278278
---------------------------------
279279

280280
There are times when it is necessary to treat an array as a different
@@ -382,7 +382,7 @@ would violate the casting rule.
382382
File "<stdin>", line 2, in <module>
383383
TypeError: Iterator requested dtype could not be cast from dtype('float64') to dtype('int64'), the operand 0 dtype, according to the rule 'same_kind'
384384

385-
Broadcasting Array Iteration
385+
Broadcasting array iteration
386386
============================
387387

388388
NumPy has a set of rules for dealing with arrays that have differing
@@ -417,7 +417,7 @@ which includes the input shapes to help diagnose the problem.
417417
...
418418
ValueError: operands could not be broadcast together with shapes (2,) (2,3)
419419

420-
Iterator-Allocated Output Arrays
420+
Iterator-allocated output arrays
421421
--------------------------------
422422

423423
A common case in NumPy functions is to have outputs allocated based

‎doc/source/reference/distutils_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _distutils-user-guide:
22

3-
NumPy Distutils - Users Guide
3+
NumPy distutils - users guide
44
=============================
55

66
.. warning::

‎doc/source/reference/global_state.rst

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

33
************
4-
Global State
4+
Global state
55
************
66

77
NumPy has a few import-time, compile-time, or runtime options
@@ -11,10 +11,10 @@ purposes and will not be interesting to the vast majority
1111
of users.
1212

1313

14-
Performance-Related Options
14+
Performance-related options
1515
===========================
1616

17-
Number of Threads used for Linear Algebra
17+
Number of threads used for Linear Algebra
1818
-----------------------------------------
1919

2020
NumPy itself is normally intentionally limited to a single thread
@@ -56,10 +56,10 @@ Setting ``NPY_DISABLE_CPU_FEATURES`` will exclude simd features at runtime.
5656
See :ref:`runtime-simd-dispatch`.
5757

5858

59-
Debugging-Related Options
59+
Debugging-related options
6060
=========================
6161

62-
Relaxed Strides Checking
62+
Relaxed strides checking
6363
------------------------
6464

6565
The *compile-time* environment variable::

‎doc/source/reference/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
.. _reference:
44

55
###############
6-
NumPy Reference
6+
NumPy reference
77
###############
88

99
:Release: |version|

‎doc/source/reference/internals.code-explanations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:orphan:
22

33
*************************
4-
NumPy C Code Explanations
4+
NumPy C code explanations
55
*************************
66

77
.. This document has been moved to ../dev/internals.code-explanations.rst.

‎doc/source/reference/routines.ctypeslib.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. module:: numpy.ctypeslib
22

33
***********************************************************
4-
C-Types Foreign Function Interface (:mod:`numpy.ctypeslib`)
4+
C-Types foreign function interface (:mod:`numpy.ctypeslib`)
55
***********************************************************
66

77
.. currentmodule:: numpy.ctypeslib

‎doc/source/reference/routines.datetime.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _routines.datetime:
22

3-
Datetime Support Functions
3+
Datetime support functions
44
**************************
55

66
.. currentmodule:: numpy
@@ -12,7 +12,7 @@ Datetime Support Functions
1212
datetime_data
1313

1414

15-
Business Day Functions
15+
Business day functions
1616
======================
1717

1818
.. currentmodule:: numpy

‎doc/source/reference/routines.io.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Data sources
8383

8484
DataSource
8585

86-
Binary Format Description
86+
Binary format description
8787
-------------------------
8888
.. autosummary::
8989
:toctree: generated/

‎doc/source/user/howtos_index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _howtos:
22

33
################
4-
NumPy How Tos
4+
NumPy how-tos
55
################
66

77
These documents are intended as recipes to common tasks using NumPy. For

‎doc/source/user/theory.broadcasting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:orphan:
22

33
===========================
4-
Array Broadcasting in Numpy
4+
Array broadcasting in Numpy
55
===========================
66

77
..

0 commit comments

Comments
 (0)
0