Skip to content

DOC: Updating some capitalization in doc/source/user_guide #32550 #47732

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
Jul 22, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 1 addition & 1 deletion doc/source/user_guide/missing_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,7 @@ is already ``False``):
True & pd.NA


``NA`` in a boolean context
``NA`` in a Boolean context
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"boolean" doesn't refer to a Boolean class, so it can be left lower case I think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright.

---------------------------

Since the actual value of an NA is unknown, it is ambiguous to convert NA
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/sparse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ have no replacement.

.. _sparse.scipysparse:

Interaction with scipy.sparse
Interaction with SciPy.sparse
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leave this one (could make it italitc or code style though)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted

-----------------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also adapt the underline?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what you mean here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand now; I'm meant to extend the underline to be the same length as the text

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed


Use :meth:`DataFrame.sparse.from_spmatrix` to create a :class:`DataFrame` with sparse values from a sparse matrix.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/timedeltas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Further, operations among the scalars yield another scalar ``Timedelta``.
"00:00:00.000123"
)

to_timedelta
To_timedelta
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would leave this one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay

~~~~~~~~~~~~

Using the top-level ``pd.to_timedelta``, you can convert a scalar, array, list,
Expand Down
8 changes: 4 additions & 4 deletions doc/source/user_guide/timeseries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{ header }}

********************************
Time series / date functionality
Time Series / date functionality
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it is not a single word, is there a specific reason to capitalize Series?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see. I'll correct that.

********************************

pandas contains extensive capabilities and features for working with time series data for all domains.
Expand Down Expand Up @@ -388,7 +388,7 @@ We subtract the epoch (midnight at January 1, 1970 UTC) and then floor divide by

.. _timeseries.origin:

Using the ``origin`` Parameter
Using the ``origin`` parameter
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Using the ``origin`` parameter, one can specify an alternative starting point for creation
Expand Down Expand Up @@ -1523,7 +1523,7 @@ or calendars with additional rules.

.. _timeseries.advanced_datetime:

Time series-related instance methods
Time Series-related instance methods
------------------------------------

Shifting / lagging
Expand Down Expand Up @@ -2601,7 +2601,7 @@ Transform nonexistent times to ``NaT`` or shift the times.

.. _timeseries.timezone_series:

Time zone series operations
Time zone Series operations
~~~~~~~~~~~~~~~~~~~~~~~~~~~

A :class:`Series` with time zone **naive** values is
Expand Down
4 changes: 2 additions & 2 deletions doc/source/user_guide/visualization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{ header }}

*******************
Chart Visualization
Chart visualization
*******************

This section demonstrates visualization through charting. For information on
Expand Down Expand Up @@ -1746,7 +1746,7 @@ Andrews curves charts:

plt.close("all")

Plotting directly with matplotlib
Plotting directly with Matplotlib
---------------------------------

In some situations it may still be preferable or necessary to prepare plots
Expand Down
4 changes: 2 additions & 2 deletions doc/source/user_guide/window.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{ header }}

********************
Windowing Operations
Windowing operations
********************

pandas contains a compact set of APIs for performing windowing operations - an operation that performs
Expand Down Expand Up @@ -490,7 +490,7 @@ For all supported aggregation functions, see :ref:`api.functions_expanding`.

.. _window.exponentially_weighted:

Exponentially Weighted window
Exponentially weighted window
-----------------------------

An exponentially weighted window is similar to an expanding window but with each prior point
Expand Down