Skip to content

Commit a6c610d

Browse files
authored
DOC: Fix capitalization of docs section headers (#32944)
1 parent c166013 commit a6c610d

File tree

5 files changed

+20
-21
lines changed

5 files changed

+20
-21
lines changed

doc/source/development/contributing_docstring.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ backticks. The following are considered inline code:
160160
161161
.. _docstring.short_summary:
162162

163-
Section 1: Short summary
163+
Section 1: short summary
164164
~~~~~~~~~~~~~~~~~~~~~~~~
165165

166166
The short summary is a single sentence that expresses what the function does in
@@ -228,7 +228,7 @@ infinitive verb.
228228
229229
.. _docstring.extended_summary:
230230

231-
Section 2: Extended summary
231+
Section 2: extended summary
232232
~~~~~~~~~~~~~~~~~~~~~~~~~~~
233233

234234
The extended summary provides details on what the function does. It should not
@@ -259,7 +259,7 @@ their use cases, if it is not too generic.
259259
260260
.. _docstring.parameters:
261261

262-
Section 3: Parameters
262+
Section 3: parameters
263263
~~~~~~~~~~~~~~~~~~~~~
264264

265265
The details of the parameters will be added in this section. This section has
@@ -424,7 +424,7 @@ For axis, the convention is to use something like:
424424

425425
.. _docstring.returns:
426426

427-
Section 4: Returns or Yields
427+
Section 4: returns or yields
428428
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429429

430430
If the method returns a value, it will be documented in this section. Also
@@ -505,7 +505,7 @@ If the method yields its value:
505505
506506
.. _docstring.see_also:
507507

508-
Section 5: See Also
508+
Section 5: see also
509509
~~~~~~~~~~~~~~~~~~~
510510

511511
This section is used to let users know about pandas functionality
@@ -583,7 +583,7 @@ For example:
583583
584584
.. _docstring.notes:
585585

586-
Section 6: Notes
586+
Section 6: notes
587587
~~~~~~~~~~~~~~~~
588588

589589
This is an optional section used for notes about the implementation of the
@@ -597,7 +597,7 @@ This section follows the same format as the extended summary section.
597597

598598
.. _docstring.examples:
599599

600-
Section 7: Examples
600+
Section 7: examples
601601
~~~~~~~~~~~~~~~~~~~
602602

603603
This is one of the most important sections of a docstring, despite being
@@ -998,4 +998,4 @@ mapping function names to docstrings. Wherever possible, we prefer using
998998

999999
See ``pandas.core.generic.NDFrame.fillna`` for an example template, and
10001000
``pandas.core.series.Series.fillna`` and ``pandas.core.generic.frame.fillna``
1001-
for the filled versions.
1001+
for the filled versions.

doc/source/development/developer.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ for each column, *including the index columns*. This has JSON form:
6262
6363
See below for the detailed specification for these.
6464

65-
Index Metadata Descriptors
65+
Index metadata descriptors
6666
~~~~~~~~~~~~~~~~~~~~~~~~~~
6767

6868
``RangeIndex`` can be stored as metadata only, not requiring serialization. The
@@ -89,7 +89,7 @@ with other column names) a disambiguating name with pattern matching
8989
columns, ``name`` attribute is always stored in the column descriptors as
9090
above.
9191

92-
Column Metadata
92+
Column metadata
9393
~~~~~~~~~~~~~~~
9494

9595
``pandas_type`` is the logical type of the column, and is one of:
@@ -182,4 +182,4 @@ As an example of fully-formed metadata:
182182
'creator': {
183183
'library': 'pyarrow',
184184
'version': '0.13.0'
185-
}}
185+
}}

doc/source/development/extending.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ will
210210

211211
.. _extending.extension.ufunc:
212212

213-
NumPy Universal Functions
213+
NumPy universal functions
214214
^^^^^^^^^^^^^^^^^^^^^^^^^
215215

216216
:class:`Series` implements ``__array_ufunc__``. As part of the implementation,
@@ -501,4 +501,4 @@ registers the default "matplotlib" backend as follows.
501501
502502
503503
More information on how to implement a third-party plotting backend can be found at
504-
https://github.com/pandas-dev/pandas/blob/master/pandas/plotting/__init__.py#L1.
504+
https://github.com/pandas-dev/pandas/blob/master/pandas/plotting/__init__.py#L1.

doc/source/development/maintaining.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _maintaining:
22

33
******************
4-
Pandas Maintenance
4+
pandas maintenance
55
******************
66

77
This guide is for pandas' maintainers. It may also be interesting to contributors
@@ -41,7 +41,7 @@ reading.
4141

4242
.. _maintaining.triage:
4343

44-
Issue Triage
44+
Issue triage
4545
------------
4646

4747

@@ -123,7 +123,7 @@ Here's a typical workflow for triaging a newly opened issue.
123123

124124
.. _maintaining.closing:
125125

126-
Closing Issues
126+
Closing issues
127127
--------------
128128

129129
Be delicate here: many people interpret closing an issue as us saying that the
@@ -132,7 +132,7 @@ respond or self-close their issue if it's determined that the behavior is not a
132132
or the feature is out of scope. Sometimes reporters just go away though, and
133133
we'll close the issue after the conversation has died.
134134

135-
Reviewing Pull Requests
135+
Reviewing pull requests
136136
-----------------------
137137

138138
Anybody can review a pull request: regular contributors, triagers, or core-team
@@ -144,7 +144,7 @@ members. Here are some guidelines to check.
144144
* User-facing changes should have a whatsnew in the appropriate file.
145145
* Regression tests should reference the original GitHub issue number like ``# GH-1234``.
146146

147-
Cleaning up old Issues
147+
Cleaning up old issues
148148
----------------------
149149

150150
Every open issue in pandas has a cost. Open issues make finding duplicates harder,
@@ -164,7 +164,7 @@ If an older issue lacks a reproducible example, label it as "Needs Info" and
164164
ask them to provide one (or write one yourself if possible). If one isn't
165165
provide reasonably soon, close it according to the policies in :ref:`maintaining.closing`.
166166

167-
Cleaning up old Pull Requests
167+
Cleaning up old pull requests
168168
-----------------------------
169169

170170
Occasionally, contributors are unable to finish off a pull request.

doc/source/development/meeting.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _meeting:
22

33
==================
4-
Developer Meetings
4+
Developer meetings
55
==================
66

77
We hold regular developer meetings on the second Wednesday
@@ -29,4 +29,3 @@ You can subscribe to this calendar with the following links:
2929

3030
Additionally, we'll sometimes have one-off meetings on specific topics.
3131
These will be published on the same calendar.
32-

0 commit comments

Comments
 (0)