Skip to content

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

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

Closed
wants to merge 3 commits into from
Closed
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. It is 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, even if it is
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.

6 changes: 3 additions & 3 deletions doc/source/development/policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Policies

.. _policies.version:

Version Policy
Version policy
~~~~~~~~~~~~~~

.. versionchanged:: 1.0.0
Expand Down Expand Up @@ -48,10 +48,10 @@ deprecation removed in the next next major release (2.0.0).
These policies do not apply to features marked as **experimental** in the documentation.
Pandas may change the behavior of experimental features at any time.

Python Support
Python support
~~~~~~~~~~~~~~

Pandas will only drop support for specific Python versions (e.g. 3.6.x, 3.7.x) in
pandas **major** releases.

.. _SemVer: https://semver.org
.. _SemVer: https://semver.org
4 changes: 2 additions & 2 deletions doc/source/development/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ We'd like to fund improvements and maintenance of these tools to

.. _roadmap.evolution:

Roadmap Evolution
Roadmap evolution
-----------------

Pandas continues to evolve. The direction is primarily determined by community
Expand All @@ -176,4 +176,4 @@ should be notified of the proposal.

When there's agreement that an implementation
would be welcome, the roadmap should be updated to include the summary and a
link to the discussion issue.
link to the discussion issue.
2 changes: 1 addition & 1 deletion doc/source/ecosystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{{ header }}

****************
Pandas ecosystem
pandas ecosystem
****************

Increasingly, packages are being built on top of pandas to address specific needs
Expand Down
4 changes: 2 additions & 2 deletions doc/source/getting_started/10min.rst
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ See more at :ref:`Histogramming and Discretization <basics.discretization>`.
s
s.value_counts()

String Methods
String methods
~~~~~~~~~~~~~~

Series is equipped with a set of string processing methods in the `str`
Expand Down Expand Up @@ -809,4 +809,4 @@ If you are attempting to perform an operation you might see an exception like:

See :ref:`Comparisons<basics.compare>` for an explanation and what to do.

See :ref:`Gotchas<gotchas>` as well.
See :ref:`Gotchas<gotchas>` as well.
8 changes: 4 additions & 4 deletions doc/source/getting_started/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1871,7 +1871,7 @@ Series has the :meth:`~Series.searchsorted` method, which works similarly to

.. _basics.nsorted:

smallest / largest values
Smallest / largest values
~~~~~~~~~~~~~~~~~~~~~~~~~

``Series`` has the :meth:`~Series.nsmallest` and :meth:`~Series.nlargest` methods which return the
Expand Down Expand Up @@ -2142,7 +2142,7 @@ Convert certain columns to a specific dtype by passing a dict to :meth:`~DataFra

.. _basics.object_conversion:

object conversion
Object conversion
~~~~~~~~~~~~~~~~~

pandas offers various functions to try to force conversion of types from the ``object`` dtype to other types.
Expand Down Expand Up @@ -2257,7 +2257,7 @@ as DataFrames. However, with :meth:`~pandas.DataFrame.apply`, we can "apply" the
df
df.apply(pd.to_timedelta)

gotchas
Gotchas
~~~~~~~

Performing selection operations on ``integer`` type data can easily upcast the data to ``floating``.
Expand Down Expand Up @@ -2372,4 +2372,4 @@ All NumPy dtypes are subclasses of ``numpy.generic``:
.. note::

Pandas also defines the types ``category``, and ``datetime64[ns, tz]``, which are not integrated into the normal
NumPy hierarchy and won't show up with the above function.
NumPy hierarchy and won't show up with the above function.
4 changes: 2 additions & 2 deletions doc/source/getting_started/comparison/comparison_with_sas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ In pandas this would be written as:
tips.groupby(['sex', 'smoker']).first()


Other Considerations
Other considerations
--------------------

Disk vs memory
Expand Down Expand Up @@ -752,4 +752,4 @@ to interop data between SAS and pandas is to serialize to csv.
Wall time: 14.6 s

In [9]: %time df = pd.read_csv('big.csv')
Wall time: 4.86 s
Wall time: 4.86 s
8 changes: 4 additions & 4 deletions doc/source/getting_started/comparison/comparison_with_sql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -388,10 +388,10 @@ In pandas, you can use :meth:`~pandas.concat` in conjunction with

pd.concat([df1, df2]).drop_duplicates()

Pandas equivalents for some SQL analytic and aggregate functions
pandas equivalents for some SQL analytic and aggregate functions
----------------------------------------------------------------

Top N rows with offset
Top n rows with offset
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: sql
Expand All @@ -405,7 +405,7 @@ Top N rows with offset

tips.nlargest(10 + 5, columns='tip').tail(10)

Top N rows per group
Top n rows per group
~~~~~~~~~~~~~~~~~~~~

.. code-block:: sql
Expand Down Expand Up @@ -490,4 +490,4 @@ In pandas we select the rows that should remain, instead of deleting them

.. ipython:: python

tips = tips.loc[tips['tip'] <= 9]
tips = tips.loc[tips['tip'] <= 9]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{{ header }}

Comparison with Stata
Comparison with STATA
*********************
For potential users coming from `Stata <https://en.wikipedia.org/wiki/Stata>`__
this page is meant to demonstrate how different Stata operations would be
Expand Down Expand Up @@ -675,4 +675,4 @@ data able to be loaded in pandas is limited by your machine's memory.
If out of core processing is needed, one possibility is the
`dask.dataframe <https://dask.pydata.org/en/latest/dataframe.html>`_
library, which provides a subset of pandas functionality for an
on-disk ``DataFrame``.
on-disk ``DataFrame``.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ documentation.
</li>
</ul>

Pandas data table representation
pandas data table representation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: ../../_static/schemas/01_table_dataframe.svg
Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting_started/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ entails.
For the table of contents, see the `pandas-cookbook GitHub
repository <https://github.com/jvns/pandas-cookbook>`_.

Learn Pandas by Hernan Rojas
Learn pandas by Hernan Rojas
----------------------------

A set of lesson for new pandas users: https://bitbucket.org/hrojas/learn-pandas
Expand Down
4 changes: 2 additions & 2 deletions doc/source/reference/arrays.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
.. _api.arrays:

=============
Pandas arrays
pandas arrays
=============

.. currentmodule:: pandas
Expand Down Expand Up @@ -519,4 +519,4 @@ with a bool :class:`numpy.ndarray`.
DatetimeTZDtype.unit
DatetimeTZDtype.tz
PeriodDtype.freq
IntervalDtype.subtype
IntervalDtype.subtype
4 changes: 2 additions & 2 deletions doc/source/reference/window.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Exponentially-weighted moving window functions
EWM.corr
EWM.cov

Window Indexer
Window indexer
--------------
.. currentmodule:: pandas

Expand All @@ -84,4 +84,4 @@ Base class for defining custom window boundaries.
.. autosummary::
:toctree: api/

api.indexers.BaseIndexer
api.indexers.BaseIndexer
Loading