Skip to content

DOC: Fix capitalization among headings in documentation files (#32550) #32944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions doc/source/development/contributing_docstring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ backticks. The following are considered inline code:

.. _docstring.short_summary:

Section 1: Short summary
Section 1: short summary
~~~~~~~~~~~~~~~~~~~~~~~~

The short summary is a single sentence that expresses what the function does in
Expand Down Expand Up @@ -228,7 +228,7 @@ infinitive verb.

.. _docstring.extended_summary:

Section 2: Extended summary
Section 2: extended summary
~~~~~~~~~~~~~~~~~~~~~~~~~~~

The extended summary provides details on what the function does. It should not
Expand Down Expand Up @@ -259,7 +259,7 @@ their use cases, if it is not too generic.

.. _docstring.parameters:

Section 3: Parameters
Section 3: parameters
~~~~~~~~~~~~~~~~~~~~~

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

.. _docstring.returns:

Section 4: Returns or Yields
Section 4: returns or yields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If the method returns a value, it will be documented in this section. Also
Expand Down Expand Up @@ -505,7 +505,7 @@ If the method yields its value:

.. _docstring.see_also:

Section 5: See Also
Section 5: see also
~~~~~~~~~~~~~~~~~~~

This section is used to let users know about pandas functionality
Expand Down Expand Up @@ -583,7 +583,7 @@ For example:

.. _docstring.notes:

Section 6: Notes
Section 6: notes
~~~~~~~~~~~~~~~~

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

.. _docstring.examples:

Section 7: Examples
Section 7: examples
~~~~~~~~~~~~~~~~~~~

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

See ``pandas.core.generic.NDFrame.fillna`` for an example template, and
``pandas.core.series.Series.fillna`` and ``pandas.core.generic.frame.fillna``
for the filled versions.
for the filled versions.
6 changes: 3 additions & 3 deletions doc/source/development/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ for each column, *including the index columns*. This has JSON form:

See below for the detailed specification for these.

Index Metadata Descriptors
Index metadata descriptors
~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Column Metadata
Column metadata
~~~~~~~~~~~~~~~

``pandas_type`` is the logical type of the column, and is one of:
Expand Down Expand Up @@ -182,4 +182,4 @@ As an example of fully-formed metadata:
'creator': {
'library': 'pyarrow',
'version': '0.13.0'
}}
}}
4 changes: 2 additions & 2 deletions doc/source/development/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ will

.. _extending.extension.ufunc:

NumPy Universal Functions
NumPy universal functions
^^^^^^^^^^^^^^^^^^^^^^^^^

:class:`Series` implements ``__array_ufunc__``. As part of the implementation,
Expand Down Expand Up @@ -501,4 +501,4 @@ registers the default "matplotlib" backend as follows.


More information on how to implement a third-party plotting backend can be found at
https://github.com/pandas-dev/pandas/blob/master/pandas/plotting/__init__.py#L1.
https://github.com/pandas-dev/pandas/blob/master/pandas/plotting/__init__.py#L1.
12 changes: 6 additions & 6 deletions doc/source/development/maintaining.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _maintaining:

******************
Pandas Maintenance
pandas maintenance
******************

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

.. _maintaining.triage:

Issue Triage
Issue triage
------------


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

.. _maintaining.closing:

Closing Issues
Closing issues
--------------

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

Reviewing Pull Requests
Reviewing pull requests
-----------------------

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

Cleaning up old Issues
Cleaning up old issues
----------------------

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

Cleaning up old Pull Requests
Cleaning up old pull requests
-----------------------------

Occasionally, contributors are unable to finish off a pull request.
Expand Down
3 changes: 1 addition & 2 deletions doc/source/development/meeting.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _meeting:

==================
Developer Meetings
Developer meetings
==================

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

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