@@ -160,7 +160,7 @@ backticks. The following are considered inline code:
160
160
161
161
.. _docstring.short_summary :
162
162
163
- Section 1: Short summary
163
+ Section 1: short summary
164
164
~~~~~~~~~~~~~~~~~~~~~~~~
165
165
166
166
The short summary is a single sentence that expresses what the function does in
@@ -228,7 +228,7 @@ infinitive verb.
228
228
229
229
.. _docstring.extended_summary :
230
230
231
- Section 2: Extended summary
231
+ Section 2: extended summary
232
232
~~~~~~~~~~~~~~~~~~~~~~~~~~~
233
233
234
234
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.
259
259
260
260
.. _docstring.parameters :
261
261
262
- Section 3: Parameters
262
+ Section 3: parameters
263
263
~~~~~~~~~~~~~~~~~~~~~
264
264
265
265
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:
424
424
425
425
.. _docstring.returns :
426
426
427
- Section 4: Returns or Yields
427
+ Section 4: returns or yields
428
428
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429
429
430
430
If the method returns a value, it will be documented in this section. Also
@@ -505,7 +505,7 @@ If the method yields its value:
505
505
506
506
.. _docstring.see_also :
507
507
508
- Section 5: See Also
508
+ Section 5: see also
509
509
~~~~~~~~~~~~~~~~~~~
510
510
511
511
This section is used to let users know about pandas functionality
@@ -583,7 +583,7 @@ For example:
583
583
584
584
.. _docstring.notes :
585
585
586
- Section 6: Notes
586
+ Section 6: notes
587
587
~~~~~~~~~~~~~~~~
588
588
589
589
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.
597
597
598
598
.. _docstring.examples :
599
599
600
- Section 7: Examples
600
+ Section 7: examples
601
601
~~~~~~~~~~~~~~~~~~~
602
602
603
603
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
998
998
999
999
See ``pandas.core.generic.NDFrame.fillna `` for an example template, and
1000
1000
``pandas.core.series.Series.fillna `` and ``pandas.core.generic.frame.fillna ``
1001
- for the filled versions.
1001
+ for the filled versions.
0 commit comments