DOC: Make section title capitalization consistent #26830 #26950

restlessadmin · 2019-06-19T17:24:26Z

closes DOC: Make section title capitalization consistent #26830

This superseeds #26933, and should contain all the fixes requested there.

codecov · 2019-06-19T18:03:12Z

Codecov Report

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

@@            Coverage Diff             @@
##           master   #26950      +/-   ##
==========================================
- Coverage   91.87%   91.86%   -0.01%     
==========================================
  Files         180      180              
  Lines       50743    50743              
==========================================
- Hits        46620    46617       -3     
- Misses       4123     4126       +3

Flag	Coverage Δ
#multiple	`90.46% <ø> (ø)`	⬆️
#single	`41.12% <ø> (-0.07%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/gbq.py	`88.88% <0%> (-11.12%)`	⬇️
pandas/core/frame.py	`96.89% <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 d47947a...970fe33. Read the comment docs.

codecov · 2019-06-19T18:03:15Z

Codecov Report

Merging #26950 into master will decrease coverage by 50.9%.
The diff coverage is 46.47%.

@@             Coverage Diff             @@
##           master   #26950       +/-   ##
===========================================
- Coverage   92.04%   41.14%   -50.91%     
===========================================
  Files         180      180               
  Lines       50714    50682       -32     
===========================================
- Hits        46679    20852    -25827     
- Misses       4035    29830    +25795

Flag	Coverage Δ
#multiple	`?`
#single	`41.14% <46.47%> (-0.82%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/json/normalize.py	`8.16% <ø> (-88.78%)`	⬇️
pandas/core/arrays/integer.py	`43.28% <ø> (-53.03%)`	⬇️
pandas/core/indexes/datetimes.py	`45.46% <ø> (-50.91%)`	⬇️
pandas/core/indexes/multi.py	`34.16% <ø> (-61.58%)`	⬇️
pandas/core/config_init.py	`86.61% <ø> (-9.2%)`	⬇️
pandas/core/indexing.py	`53.64% <ø> (-39.66%)`	⬇️
pandas/core/reshape/tile.py	`11.04% <ø> (-86.63%)`	⬇️
pandas/core/sparse/scipy_sparse.py	`10.14% <ø> (-89.86%)`	⬇️
pandas/core/groupby/generic.py	`14.82% <ø> (-74.52%)`	⬇️
pandas/core/generic.py	`38.45% <ø> (-55.75%)`	⬇️
... and 195 more

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 e955515...e85502c. Read the comment docs.

datapythonista

Looks good, there is just one of the cases from the previous review that wasn't changed.

datapythonista · 2019-06-19T18:26:14Z

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


values in lowercase

Corrected that line.

datapythonista

Thanks @pmaxey83 great work here, will be nice to see the documentation rendered once this is merged (it'll be automatically published at dev.pandas.io)

Btw, for future contributions it'll be useful for you to use a separate branch for every PR you want to open. If you wanted to start working in something else now (until this is merged), you don't have an easy way, since you've got this in master (where other branches are created from).

datapythonista · 2019-06-19T18:56:43Z

@jorisvandenbossche merge when you're happy (and when you have time to review, will take a bit ;) )

jreback

couple of very small changes. ping on green.

jreback · 2019-06-21T01:13:03Z

doc/source/reference/series.rst

@@ -119,7 +119,7 @@ Binary operator functions
   Series.product
   Series.dot

-Function application, GroupBy & Window
+Function application, GroupBy & window


doc/source/user_guide/options.rst

jorisvandenbossche · 2019-06-20T13:57:30Z

doc/source/development/contributing_docstring.rst

@@ -505,7 +505,7 @@ If the method yields its value:

 .. _docstring.see_also:

-Section 5: See Also
+Section 5: See also


The section is called "See Also" with strict capitalisation, so you can leave that here as well

jorisvandenbossche · 2019-06-21T06:20:55Z

doc/source/user_guide/advanced.rst

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

-The :class:`MultiIndex` keeps all the defined levels of an index, even
+The repr of a ``MultiIndex`` shows all the defined levels of an index, even


I don't think this is a fully correct change. It is indeed shown in the repr, but here I think it was emphasized that the actual object keeps those.

jorisvandenbossche · 2019-06-21T06:21:58Z

doc/source/user_guide/advanced.rst

 if they are not actually used. When slicing an index, you may notice this.
 For example:

 .. ipython:: python

-   df.columns.levels  # original MultiIndex
+   df.columns  # original MultiIndex


Can you revert this?
I would keep it here strictly on capitalisation changes, that makes it easier to review.

I think the above is also not a correct change, as we just changed the repr of a MI, and it will no longer show all levels, so you really need to look at the .levels attribute

jorisvandenbossche · 2019-06-21T06:24:20Z

doc/source/user_guide/advanced.rst

@@ -210,8 +210,7 @@ To reconstruct the ``MultiIndex`` with only the used levels, the

 .. ipython:: python

-   new_mi = df[['foo', 'qux']].columns.remove_unused_levels()
-   new_mi.levels


also revert this one

jorisvandenbossche · 2019-06-21T06:25:42Z

doc/source/user_guide/cookbook.rst

@@ -706,7 +706,7 @@ Apply
                        for ind, row in df.iterrows()})
   df_orgz

-`Rolling Apply with a DataFrame returning a Series
+`Rolling apply with a DataFrame returning a series


Suggested change

`Rolling apply with a DataFrame returning a series

`Rolling apply with a DataFrame returning a Series

jorisvandenbossche · 2019-06-21T06:38:04Z

doc/source/user_guide/options.rst

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

-Using startup scripts for the python/ipython environment to import pandas and set options makes working with pandas more efficient.  To do this, create a .py or .ipy script in the startup directory of the desired profile.  An example where the startup folder is in a default ipython profile can be found at:
+Using startup scripts for the Python/Ipython environment to import pandas and set options makes working with pandas more efficient.  To do this, create a .py or .ipy script in the startup directory of the desired profile.  An example where the startup folder is in a default ipython profile can be found at:


Suggested change

Using startup scripts for the Python/Ipython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at:

Using startup scripts for the Python/IPython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at:

jorisvandenbossche · 2019-06-21T06:50:17Z

doc/source/whatsnew/v0.10.0.rst

@@ -490,7 +490,7 @@ Updated PyTables Support
 however, query terms using the prior (undocumented) methodology are unsupported. You must read in the entire
 file and write it out using the new format to take advantage of the updates.

-N Dimensional Panels (Experimental)
+N dimensional panels (experimental)


Suggested change

N dimensional panels (experimental)

N dimensional Panels (experimental)

jorisvandenbossche · 2019-06-21T06:59:07Z

doc/source/whatsnew/v0.25.0.rst

@@ -74,41 +74,9 @@ a dict to a Series groupby aggregation (:ref:`whatsnew_0200.api_breaking.depreca

 See :ref:`groupby.aggregate.named` for more.

-
-.. _whatsnew_0250.enhancements.multi_index_repr:
-


Ah, this is probably something that went wrong with updating with latest master, as this was a recent PR that was merged.
My previous comments about things you changed in the MultiIndex text is probably caused by that as well.

I would do:

git fetch upstream git merge upstream/master

in this branch.

this is still missing

restlessadmin · 2019-06-21T17:23:24Z

That makes sense, I was really confused by those changes to MultiIndex. I have ran the specified commands and will apply the suggested changes.

…

On Fri, Jun 21, 2019 at 12:00 AM Joris Van den Bossche < ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In doc/source/development/contributing_docstring.rst <#26950 (comment)>: > @@ -505,7 +505,7 @@ If the method yields its value: .. _docstring.see_also: -Section 5: See Also +Section 5: See also The section is called "See Also" with strict capitalisation, so you can leave that here as well ------------------------------ In doc/source/user_guide/advanced.rst <#26950 (comment)>: > ~~~~~~~~~~~~~~ -The :class:`MultiIndex` keeps all the defined levels of an index, even +The repr of a ``MultiIndex`` shows all the defined levels of an index, even I don't think this is a fully correct change. It is indeed shown in the repr, but here I think it was emphasized that the actual object keeps those. ------------------------------ In doc/source/user_guide/advanced.rst <#26950 (comment)>: > if they are not actually used. When slicing an index, you may notice this. For example: .. ipython:: python - df.columns.levels # original MultiIndex + df.columns # original MultiIndex Can you revert this? I would keep it here strictly on capitalisation changes, that makes it easier to review. I think the above is also not a correct change, as we just changed the repr of a MI, and it will no longer show all levels, so you really need to look at the .levels attribute ------------------------------ In doc/source/user_guide/advanced.rst <#26950 (comment)>: > @@ -210,8 +210,7 @@ To reconstruct the ``MultiIndex`` with only the used levels, the .. ipython:: python - new_mi = df[['foo', 'qux']].columns.remove_unused_levels() - new_mi.levels also revert this one ------------------------------ In doc/source/user_guide/cookbook.rst <#26950 (comment)>: > @@ -706,7 +706,7 @@ Apply for ind, row in df.iterrows()}) df_orgz -`Rolling Apply with a DataFrame returning a Series +`Rolling apply with a DataFrame returning a series ⬇️ Suggested change -`Rolling apply with a DataFrame returning a series +`Rolling apply with a DataFrame returning a Series ------------------------------ In doc/source/user_guide/options.rst <#26950 (comment)>: > ----------------------------------------------------- -Using startup scripts for the python/ipython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at: +Using startup scripts for the Python/Ipython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at: ⬇️ Suggested change -Using startup scripts for the Python/Ipython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at: +Using startup scripts for the Python/IPython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at: ------------------------------ In doc/source/whatsnew/v0.10.0.rst <#26950 (comment)>: > @@ -490,7 +490,7 @@ Updated PyTables Support however, query terms using the prior (undocumented) methodology are unsupported. You must read in the entire file and write it out using the new format to take advantage of the updates. -N Dimensional Panels (Experimental) +N dimensional panels (experimental) ⬇️ Suggested change -N dimensional panels (experimental) +N dimensional Panels (experimental) ------------------------------ In doc/source/whatsnew/v0.25.0.rst <#26950 (comment)>: > @@ -74,41 +74,9 @@ a dict to a Series groupby aggregation (:ref:`whatsnew_0200.api_breaking.depreca See :ref:`groupby.aggregate.named` for more. - -.. _whatsnew_0250.enhancements.multi_index_repr: - Ah, this is probably something that went wrong with updating with latest master, as this was a recent PR that was merged. My previous comments about things you changed in the MultiIndex text is probably caused by that as well. I would do: git fetch upstream git merge upstream/master in this branch. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#26950?email_source=notifications&email_token=AFA5BYKSVXYZZEXCVLTCMD3P3R4CTA5CNFSM4HZLYI6KYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB4E6KUQ#pullrequestreview-252306770>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFA5BYLF752RVPVBBMOPIB3P3R4CTANCNFSM4HZLYI6A> .

datapythonista

Thanks @pmaxey83, there are still few unrelated changes possibly from a merge. Can you fix those, and the couple of cases in the review comments, so we can get this merged. Thanks!

datapythonista · 2019-06-25T14:21:09Z

doc/source/user_guide/advanced.rst

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

-The :class:`MultiIndex` keeps all the defined levels of an index, even
+The repr of a ``MultiIndex`` shows all the defined levels of an index, even


Not sure if this is from a merge, but we avoid having unrelated changes in PRs, in case something goes wrong and we need to revert. If this comes from a merge that applies it, please revert to the original. If it's you proposing to change those, that's welcome, but please open a separate PR for anything that is not about fixing the capitalization of titles.

datapythonista · 2019-06-25T14:21:17Z

doc/source/user_guide/advanced.rst

 if they are not actually used. When slicing an index, you may notice this.
 For example:

 .. ipython:: python

-   df.columns.levels  # original MultiIndex
+   df.columns  # original MultiIndex


datapythonista · 2019-06-25T14:21:23Z

doc/source/user_guide/advanced.rst


-   df[['foo','qux']].columns.levels  # sliced
+   df[['foo','qux']].columns  # sliced


datapythonista · 2019-06-25T14:21:30Z

doc/source/user_guide/advanced.rst

@@ -210,8 +210,7 @@ To reconstruct the ``MultiIndex`` with only the used levels, the

 .. ipython:: python

-   new_mi = df[['foo', 'qux']].columns.remove_unused_levels()
-   new_mi.levels
+   df[['foo', 'qux']].columns.remove_unused_levels()


datapythonista · 2019-06-25T14:22:23Z

doc/source/user_guide/cookbook.rst

@@ -1099,7 +1099,7 @@ HDFStore

 The :ref:`HDFStores <io.hdf5>` docs

-`Simple Queries with a Timestamp Index
+`Simple queries with a timestamp index


Timestamp and Index are class names, can you leave the capitalization of those please

datapythonista · 2019-06-25T14:23:02Z

doc/source/user_guide/groupby.rst

@@ -321,7 +321,7 @@ Index level names may be supplied as keys.

 More on the ``sum`` function and aggregation later.

-Grouping DataFrame with Index Levels and Columns
+Grouping DataFrame with index levels and columns


Can you leave Index with uppercase

datapythonista · 2019-06-25T14:24:38Z

doc/source/user_guide/options.rst

@@ -120,10 +120,10 @@ are restored automatically when you exit the `with` block:
   print(pd.get_option("display.max_columns"))


-Setting Startup Options in python/ipython Environment
+Setting startup options in Python/Ipython environment


IPython with capital P too

datapythonista · 2019-06-25T14:27:59Z

doc/source/whatsnew/v0.21.0.rst

@@ -507,7 +507,7 @@ The configuration option ``pd.options.mode.use_inf_as_null`` is deprecated, and

 .. _whatsnew_0210.api_breaking.iteration_scalars:

-Iteration of Series/Index will now return Python scalars
+Iteration of series/index will now return Python scalars


Series/Index with capital S and I

datapythonista · 2019-06-25T14:30:05Z

doc/source/whatsnew/v0.25.0.rst

@@ -74,41 +74,9 @@ a dict to a Series groupby aggregation (:ref:`whatsnew_0200.api_breaking.depreca

 See :ref:`groupby.aggregate.named` for more.

-
-.. _whatsnew_0250.enhancements.multi_index_repr:
-


this is still missing

jorisvandenbossche · 2019-06-25T19:20:45Z

@pmaxey83 it seems that again something went wrong with merging master, as there a couple of changes in here from recent other PRs. Not fully sure how that happened or so what to recommend doing. One option might be to start from a clean branch from master, and only cherry-pick the commits from this branch with actual doc changes.

pep8speaks · 2019-06-26T17:27:19Z

Hello @pmaxey83! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file pandas/tests/io/test_pytables.py:

Line 3288:13: E741 ambiguous variable name 'l'

datapythonista

@pmaxey83 I saw you were having trouble restoring this PR to a correct state without unrelated changes, so I fixed it for you. You can leave it with us, no need to push or change anything, should be ready to merge now.

@jreback @jorisvandenbossche can you have a last look and merge if everything looks good please?

jorisvandenbossche · 2019-06-27T21:25:13Z

@pmaxey83 Thanks a lot!

DOC: Make section title capitalization consistent #26830

970fe33

datapythonista reviewed Jun 19, 2019

View reviewed changes

DOC: Corrected line 646

c06bd34

datapythonista added the Docs label Jun 19, 2019

datapythonista approved these changes Jun 19, 2019

View reviewed changes

gfyoung mentioned this pull request Jun 20, 2019

Docs: Capitalisation of title line changed to lower case #26942

Closed

4 tasks

jreback requested changes Jun 21, 2019

View reviewed changes

jreback added this to the 0.25.0 milestone Jun 21, 2019

jorisvandenbossche reviewed Jun 21, 2019

View reviewed changes

Merge remote-tracking branch 'upstream/master'

8e833a8

restlessadmin added 2 commits June 24, 2019 09:57

Merge remote-tracking branch 'upstream/master'

933d0cd

Updated Doc files with suggested changes.

830519a

datapythonista reviewed Jun 25, 2019

View reviewed changes

datapythonista added 3 commits June 27, 2019 09:51

Merge remote-tracking branch 'upstream/master' into pmaxey83-master

3377fb3

Updated files with suggested changes.

474f5a4

Reverting unrelated changes

e85502c

datapythonista approved these changes Jun 27, 2019

View reviewed changes

jorisvandenbossche approved these changes Jun 27, 2019

View reviewed changes

Merge branch 'master' into master

83e126a

jorisvandenbossche merged commit 1c0eb45 into pandas-dev:master Jun 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Make section title capitalization consistent #26830 #26950

DOC: Make section title capitalization consistent #26830 #26950

restlessadmin commented Jun 19, 2019 •

edited by datapythonista

Loading

codecov bot commented Jun 19, 2019

codecov bot commented Jun 19, 2019 •

edited

Loading

datapythonista left a comment

datapythonista Jun 19, 2019

restlessadmin Jun 19, 2019

datapythonista left a comment

datapythonista commented Jun 19, 2019

jreback left a comment

jreback Jun 21, 2019

jorisvandenbossche Jun 20, 2019

jorisvandenbossche Jun 21, 2019

jorisvandenbossche Jun 21, 2019

jorisvandenbossche Jun 21, 2019

jorisvandenbossche Jun 21, 2019

jorisvandenbossche Jun 21, 2019

jorisvandenbossche Jun 21, 2019

jorisvandenbossche Jun 21, 2019

datapythonista Jun 25, 2019

restlessadmin commented Jun 21, 2019 via email

datapythonista left a comment

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

datapythonista Jun 25, 2019

jorisvandenbossche commented Jun 25, 2019

pep8speaks commented Jun 26, 2019

datapythonista left a comment •

edited

Loading

jorisvandenbossche commented Jun 27, 2019

	`Rolling apply with a DataFrame returning a series
	`Rolling apply with a DataFrame returning a Series

	Using startup scripts for the Python/Ipython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at:
	Using startup scripts for the Python/IPython environment to import pandas and set options makes working with pandas more efficient. To do this, create a .py or .ipy script in the startup directory of the desired profile. An example where the startup folder is in a default ipython profile can be found at:

	N dimensional panels (experimental)
	N dimensional Panels (experimental)

		@@ -74,41 +74,9 @@ a dict to a Series groupby aggregation (:ref:`whatsnew_0200.api_breaking.depreca

		See :ref:`groupby.aggregate.named` for more.


		.. _whatsnew_0250.enhancements.multi_index_repr:


		df[['foo','qux']].columns.levels # sliced
		df[['foo','qux']].columns # sliced

DOC: Make section title capitalization consistent #26830 #26950

DOC: Make section title capitalization consistent #26830 #26950

Conversation

restlessadmin commented Jun 19, 2019 • edited by datapythonista Loading

codecov bot commented Jun 19, 2019

Codecov Report

codecov bot commented Jun 19, 2019 • edited Loading

Codecov Report

datapythonista left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

datapythonista left a comment

Choose a reason for hiding this comment

datapythonista commented Jun 19, 2019

jreback left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

restlessadmin commented Jun 21, 2019 via email

datapythonista left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorisvandenbossche commented Jun 25, 2019

pep8speaks commented Jun 26, 2019

datapythonista left a comment • edited Loading

Choose a reason for hiding this comment

jorisvandenbossche commented Jun 27, 2019

restlessadmin commented Jun 19, 2019 •

edited by datapythonista

Loading

codecov bot commented Jun 19, 2019 •

edited

Loading

datapythonista left a comment •

edited

Loading