Skip to content

DOC: Make section title capitalization consistent #26830 #26933

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

DOC: Make section title capitalization consistent #26830 #26933

wants to merge 1 commit into from

Conversation

restlessadmin
Copy link
Contributor

@restlessadmin restlessadmin commented Jun 18, 2019 •
edited
Loading

@codecov
Copy link

codecov bot commented Jun 18, 2019

Codecov Report

Merging #26933 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #26933      +/-   ##
==========================================
- Coverage   91.87%   91.86%   -0.01%     
==========================================
  Files         180      180              
  Lines       50716    50716              
==========================================
- Hits        46593    46590       -3     
- Misses       4123     4126       +3
Flag Coverage Δ
#multiple 90.45% <ø> (ø) ⬆️
#single 41.12% <ø> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/io/gbq.py 88.88% <0%> (-11.12%) ⬇️
pandas/core/frame.py 96.88% <0%> (-0.12%) ⬇️
pandas/util/testing.py 90.94% <0%> (+0.1%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d39a6de...217c67e. Read the comment docs.

jreback
jreback requested changes Jun 19, 2019
View reviewed changes
Copy link
Contributor

@jreback jreback left a comment

Choose a reason for hiding this comment

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

I believe most of these are actually purposful, what was the intent on the changes here? e.g. section headers should be more sentence like?

cc @jorisvandenbossche @datapythonista

doc/source/development/extending.rst
@@ -3,7 +3,7 @@
{{ header }}

****************
Extending Pandas
Extending pandas
Copy link
Contributor

Choose a reason for hiding this comment

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

shouldn't change major headings

@jreback jreback added the Docs label Jun 19, 2019
@jreback
Copy link
Contributor

jreback commented Jun 19, 2019

@datapythonista @jorisvandenbossche I see your discussion, but do we really want this to apply to all headers; what is the theory here?

@restlessadmin
Copy link
Contributor Author

I think I went too literal on all the headers. I will cancel this PR.

@jorisvandenbossche
Copy link
Member

@jreback Let's then have the discussion on the issue. Can you comment there what logic you would follow on which headers to apply and which not? (our theory: consistency for all headers)

I think I went too literal on all the headers. I will cancel this PR.

@pmaxey83 no, no, you did what was described in the issue. It's just that we don't yet fully agree about that. You will need to have some patience.

@restlessadmin
Copy link
Contributor Author

restlessadmin commented Jun 19, 2019 via email

@jorisvandenbossche
Copy link
Member

As I said, no need to be sorry. As you did what was described correctly. There is only not yet a full agreement on what was described there.

@jorisvandenbossche
Copy link
Member

@pmaxey83 Can you reopen the pull request, or restore your branch? (depending on the outcome of the discussion, those changes are useful)

@datapythonista
Copy link
Member

datapythonista commented Jun 19, 2019 •
edited by jorisvandenbossche
Loading

Thanks @pmaxey83, great job here. Sorry it's been my fault that I assumed the discussion in this issue was finished too early. Also, I wasn't clear, but my idea was to start only with the title sections visible in the home page, and take care of the rest later.

As @jorisvandenbossche said, please restore your remote branch, there is a lot of great work there I hope we want to get into the docs.

@jreback
Copy link
Contributor

jreback commented Jun 19, 2019

@pmaxey83 yeah didn't mean for you to close this, I had already commented when I actually read the issue :->

datapythonista
datapythonista reviewed Jun 19, 2019
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Amazing clean up @pmaxey83, thanks a lot for the effort.

We're moving forward with this, just few cases that should be changed (mainly class names that we want to keep with the first letter capitalized), and we're ready to merge.

doc/source/getting_started/basics.rst
@@ -643,7 +643,7 @@ there for details about accepted inputs.

.. _basics.idxmin:

Index of Min/Max Values
Index of min/max Values
Copy link
Member

Choose a reason for hiding this comment

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

Values also

doc/source/user_guide/categorical.rst
@@ -1191,7 +1191,7 @@ change the original ``Categorical``:
df["cat"].cat.categories = [1, 2, 3, 4, 5]
cat

Use ``copy=True`` to prevent such a behaviour or simply don't reuse ``Categoricals``:
Use ``copy=True`` to prevent such a behavior or simply don't reuse ``Categoricals``:
Copy link
Member

Choose a reason for hiding this comment

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

haha, you're starting a British vs American English war here, but good catch ;)

doc/source/user_guide/enhancingperf.rst
@@ -15,7 +15,7 @@ when we use Cython and Numba on a test function operating row-wise on the

.. _enhancingperf.cython:

Cython (Writing C extensions for pandas)
Cython (writing C extensions for Pandas)
Copy link
Member

Choose a reason for hiding this comment

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

We use pandas lowercase, as a trademark, can you restore this one please

doc/source/user_guide/gotchas.rst
@@ -75,10 +75,10 @@ See also :ref:`Categorical Memory Usage <categorical.memory>`.

.. _gotchas.truth:

Using If/Truth Statements with pandas
Using if/truth statements with Pandas
Copy link
Member

Choose a reason for hiding this comment

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

same regarding pandas

doc/source/user_guide/gotchas.rst
-------------------------------------

pandas follows the NumPy convention of raising an error when you try to convert
Pandas follows the NumPy convention of raising an error when you try to convert
Copy link
Member

Choose a reason for hiding this comment

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

same

doc/source/whatsnew/v0.24.0.rst
@@ -194,7 +194,7 @@ is a float.

.. _whatsnew_0240.enhancements.interval:

Storing Interval and Period Data in Series and DataFrame
Storing interval and period data in series and DataFrame
Copy link
Member

Choose a reason for hiding this comment

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

Interval and Period are classes too, also Series

doc/source/whatsnew/v0.24.0.rst
@@ -1105,13 +1105,13 @@ broadcast. (:issue:`23000`)

.. _whatsnew_0240.api.incompatibilities:

Series and Index Data-Dtype Incompatibilities
Series and index data-dtype incompatibilities
Copy link
Member

Choose a reason for hiding this comment

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

Index is a class

doc/source/whatsnew/v0.24.0.rst
@@ -1417,7 +1417,7 @@ The old behavior can be retained with by localizing directly to the final timezo

.. _whatsnew_0240.deprecations.tz_aware_array:

Converting Timezone-Aware Series and Index to NumPy Arrays
Converting timezone-aware series and index to NumPy arrays
Copy link
Member

Choose a reason for hiding this comment

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

Series and Index, class names

doc/source/whatsnew/v0.25.0.rst
@@ -286,7 +286,7 @@ of ``object`` dtype. :attr:`Series.str` will now infer the dtype data *within* t

.. _whatsnew_0250.api_breaking.incompatible_index_unions:

Incompatible Index Type Unions
Incompatible index type unions
Copy link
Member

Choose a reason for hiding this comment

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

same about Index

doc/source/whatsnew/v0.7.0.rst
@@ -227,7 +227,7 @@ If the index had been sorted, the "range selection" would have been possible:
g -1.182230
dtype: float64

Changes to Series ``[]`` operator
Changes to series ``[]`` operator
Copy link
Member

Choose a reason for hiding this comment

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

same

@restlessadmin
Copy link
Contributor Author

restlessadmin commented Jun 19, 2019 via email

@datapythonista
Copy link
Member

Since your remote branch has been deleted, may be it's better to rename your local branch git branch -m <new_name> from your branch, push to a new remote branch, and open a new PR (referencing this to keep them linked). I guess GitHub is smart enough to keep everything (code history, comments,...), but not sure.

@datapythonista datapythonista mentioned this pull request Jun 19, 2019
Closed
@jorisvandenbossche jorisvandenbossche mentioned this pull request Jun 19, 2019
Closed
4 tasks
@restlessadmin
Copy link
Contributor Author

restlessadmin commented Jun 19, 2019 via email

@datapythonista
Copy link
Member

I was guessing that, that's why I suggested to rename the branch and open a new PR. I see you opened #26830. For the next time, it's usually a good practice to reference this PR there, so it's easier to go from one to the other, and in the history we know what happened, in case we need to investigate problems.

@restlessadmin restlessadmin mentioned this pull request Jun 19, 2019
Merged
1 task
@restlessadmin
Copy link
Contributor Author

restlessadmin commented Jun 19, 2019 via email

@datapythonista
Copy link
Member

no worries, nobody does it the first time, that's why I was telling you how we usually do it :)

@tonywu1999 tonywu1999 mentioned this pull request Mar 9, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista left review comments

@jreback jreback jreback requested changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DOC: Make section title capitalization consistent
4 participants
@restlessadmin @jreback @jorisvandenbossche @datapythonista