DOC: Fix heading capitalization in doc/source/whatsnew - part5 (#32550) #33568

cleconte987 · 2020-04-15T15:53:50Z

-Quite a lot of complicated issues here, need reviewing. Such as 'Groupby' transformed to 'GroupBy', 'I/O' to 'IO', and some others.

Modify files v0.18.0.rst, v0.18.1.rst, v0.19.0.rst, v0.19.1.rst, v0.19.2.rst, v0.20.0.rst, v0.20.2.rst, v0.20.3.rst, v0.21.0.rst, v0.21.1.rst

-File v0.20.0.rst has bad file name as it is actually talking about version v0.20.1.rst

…part5)

…y_doc/source/whatsnew5

WillAyd

Looks good; a few minor nits

WillAyd · 2020-04-15T19:42:15Z

doc/source/whatsnew/v0.19.0.rst

@@ -37,8 +37,8 @@ New features

 .. _whatsnew_0190.enhancements.asof_merge:

-``merge_asof`` for asof-style time-series joining
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Method ``merge_asof`` for asof-style time-Series joining


Suggested change

Method ``merge_asof`` for asof-style time-Series joining

Function ``merge_asof`` for asof-style time-Series joining

WillAyd · 2020-04-15T19:42:34Z

doc/source/whatsnew/v0.19.0.rst

@@ -863,8 +863,8 @@ Furthermore:
 ``Period`` changes
 ^^^^^^^^^^^^^^^^^^

-``PeriodIndex`` now has ``period`` dtype
-""""""""""""""""""""""""""""""""""""""""
+Method ``PeriodIndex`` now has ``Period`` dtype


Suggested change

Method ``PeriodIndex`` now has ``Period`` dtype

The ``PeriodIndex`` now has ``Period`` dtype

Minor edit as not a method

Oups I didn't see it was a class

WillAyd · 2020-04-15T19:42:44Z

doc/source/whatsnew/v0.19.0.rst

@@ -1151,8 +1151,8 @@ As a consequence, ``groupby`` and ``set_index`` also preserve categorical dtypes

 .. _whatsnew_0190.api.autogenerated_chunksize_index:

-``read_csv`` will progressively enumerate chunks
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Method ``read_csv`` will progressively enumerate chunks


Suggested change

Method ``read_csv`` will progressively enumerate chunks

Function ``read_csv`` will progressively enumerate chunks

WillAyd · 2020-04-15T19:43:14Z

doc/source/whatsnew/v0.20.0.rst

@@ -1351,7 +1351,7 @@ Using ``.iloc``. Here we will get the location of the 'A' column, then use *posi

 .. _whatsnew_0200.api_breaking.deprecate_panel:

-Deprecate Panel
+Deprecate panel


I think Panel should still be uppercase

…y_doc/source/whatsnew5

cleconte987 · 2020-04-16T19:11:20Z

Looks good; a few minor nits

Ok changes made as requested.

…pts/validate_rst_title_capitalization.py'

jbrockmendel · 2020-04-16T23:06:16Z

doc/source/whatsnew/v0.19.0.rst

@@ -731,8 +731,8 @@ A ``Series`` will now correctly promote its dtype for assignment with incompat v

 .. _whatsnew_0190.api.to_datetime_coerce:

-``.to_datetime()`` changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Method ``.to_datetime()`` changes


@datapythonista should this be Function instead of Method?

Yes, I think so.

azure-pipelines · 2020-04-19T11:32:35Z

Commenter does not have sufficient privileges for PR 33568 in repo pandas-dev/pandas

cleconte987 · 2020-04-19T11:33:20Z

@jbrockmendel @WillAyd I made the change

…y_doc/source/whatsnew5

WillAyd · 2020-04-22T03:52:55Z

doc/source/whatsnew/v0.18.1.rst

@@ -61,8 +61,8 @@ Tuesday after MLK Day (Monday is skipped because it's a holiday)

 .. _whatsnew_0181.deferred_ops:

-``.groupby(..)`` syntax with window and resample operations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Method ``.GroupBy(..)`` syntax with window and resample operations


Suggested change

Method ``.GroupBy(..)`` syntax with window and resample operations

Method ``.groupby(..)`` syntax with window and resample operations

If referring to the method should stick with .groupby The class can be capitalized

Ok but we need to change the algorithm in validate_rst_title_capitalization, because at the moment, every word 'groupby' will be seen as an exception, and needed to be capitalised like 'GroupBy'.

Can you leave these .groupby methods in lower case. Not sure what's the best solution here, it needs to be GroupBy when it's a class, and groupby when it's a method. And making the script be happy with both is not trivial, the way it is implemented.

So, let's leave them correct for now, even if we can't add the validation to this file, and see what we do with the script. If you can open an issue for this case, that would be great. You can tag me on the issue. Thanks!

Ok, I will switch back to .groupby and I will open an issue! And try to propose a solution when I can spend some time on it.

WillAyd · 2020-04-22T03:53:06Z

doc/source/whatsnew/v0.18.1.rst

@@ -306,8 +306,8 @@ API changes

 .. _whatsnew_0181.api.groubynth:



…y_doc/source/whatsnew5

datapythonista

Thanks for the changes. Looks good, there are few other cases that we need to allow two variants.

The problem with the current implementation is that we get the "right" of writing the title to show to the user. But if we need to allow two variants, there is no right way anymore, so I guess we'll have to get rid of that feature, and just validate that incorrectly capitalized words are not in the list of exceptions.

For this PR, if you can just restore the cases I mentioned, we can get this merged. If you want to create an issue for the problem, or work on a separate PR that fixes it, that would be great.

Thanks a lot for the work on this!

datapythonista · 2020-05-01T09:24:01Z

doc/source/whatsnew/v0.19.0.rst

@@ -37,8 +37,8 @@ New features

 .. _whatsnew_0190.enhancements.asof_merge:

-``merge_asof`` for asof-style time-series joining
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Function ``merge_asof`` for asof-style time-Series joining


do you mind restoring series here? This one is not referring to the class

datapythonista · 2020-05-01T09:24:11Z

doc/source/whatsnew/v0.19.0.rst

@@ -127,8 +127,8 @@ passed DataFrame (``trades`` in this case), with the fields of the ``quotes`` me

 .. _whatsnew_0190.enhancements.rolling_ts:

-``.rolling()`` is now time-series aware
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Method ``.rolling()`` is now time-Series aware


datapythonista · 2020-05-01T09:25:17Z

doc/source/whatsnew/v0.19.0.rst

@@ -863,8 +863,8 @@ Furthermore:
 ``Period`` changes
 ^^^^^^^^^^^^^^^^^^

-``PeriodIndex`` now has ``period`` dtype
-""""""""""""""""""""""""""""""""""""""""
+The ``PeriodIndex`` now has ``Period`` dtype


I think period is another one that will have to allow both period and Period. Can you use period lower case here please?

datapythonista · 2020-05-01T09:25:37Z

doc/source/whatsnew/v0.19.0.rst

@@ -1078,7 +1078,7 @@ Previously, most ``Index`` classes returned ``np.ndarray``, and ``DatetimeIndex`

 .. _whatsnew_0190.api.multiindex:

-``MultiIndex`` constructors, ``groupby`` and ``set_index`` preserve categorical dtypes
+``MultiIndex`` constructors, ``groupby`` and ``set_index`` preserve Categorical dtypes


same here for categorical, better lower case

datapythonista · 2020-05-01T09:26:43Z

doc/source/whatsnew/v0.21.0.rst

@@ -115,8 +115,8 @@ Setting a list-like data structure into a new attribute now raises a ``UserWarni

 .. _whatsnew_0210.enhancements.drop_api:

-``drop`` now also accepts index/columns keywords
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Method ``drop`` now also accepts Index/columns keywords


I think index here doesn't refer to the class either, if you can restore it

…y_doc/source/whatsnew5

datapythonista

Thanks @cleconte987 for all the work in this, lgtm

…y_doc/source/whatsnew5

cleconte987 · 2020-05-05T20:45:44Z

I don't understand what is going wrong during the checks

datapythonista

Thanks @cleconte987 nice work. The CI is green, I guess you already fixed the problems you mentioned.

cleconte987 · 2020-05-06T17:51:02Z

Thanks @cleconte987 nice work. The CI is green, I guess you already fixed the problems you mentioned.

No I just merged master and pushed, updated PR, and it worked this time. It happened several times that checks failed and I have no idea why it happens. Maybe server issues, server load or server busy I don't understand why is it failing.

WillAyd · 2020-05-06T21:14:57Z

Thanks @cleconte987

…s-dev#32550) (pandas-dev#33568)

cleconte987 added 3 commits April 15, 2020 16:30

Modify headings capitalizations inside files in doc/source/whatsnew (…

ad2bd0c

…part5)

Merge remote-tracking branch 'upstream_main_pandas/master' into modif…

aff897f

…y_doc/source/whatsnew5

Correct various mistakes

b393b54

WillAyd requested changes Apr 15, 2020

View reviewed changes

WillAyd added the Docs label Apr 15, 2020

Merge remote-tracking branch 'upstream_main_pandas/master' into modif…

d17f46e

…y_doc/source/whatsnew5

Minor changes and corrections to headings, and to exceptions in 'scri…

3751c83

…pts/validate_rst_title_capitalization.py'

jreback added this to the 1.1 milestone Apr 16, 2020

jbrockmendel reviewed Apr 16, 2020

View reviewed changes

cleconte987 added 2 commits April 18, 2020 23:20

Merge upstream/master and resolve conflicts

26ccbda

Modify Heading line 734 in file 'v0.19.0.rst'

7953907

Merge remote-tracking branch 'upstream_main_pandas/master' into modif…

f9b39cc

…y_doc/source/whatsnew5

WillAyd requested changes Apr 22, 2020

View reviewed changes

cleconte987 added 2 commits April 30, 2020 18:27

Merge remote-tracking branch 'upstream_main_pandas/master' into modif…

0291e25

…y_doc/source/whatsnew5

Move back 'GroupBy' to 'groupby' for methods containing with that name

b095965

datapythonista reviewed May 1, 2020

View reviewed changes

cleconte987 added 2 commits May 2, 2020 17:47

Merge remote-tracking branch 'upstream_main_pandas/master' into modif…

916e7dd

…y_doc/source/whatsnew5

Last modifications

b2b5dfa

datapythonista approved these changes May 3, 2020

View reviewed changes

Merge remote-tracking branch 'upstream_main_pandas/master' into modif…

d879349

…y_doc/source/whatsnew5

cleconte987 requested a review from WillAyd May 5, 2020 16:06

Merge remote-tracking branch 'upstream_main_pandas/master' into modif…

67cd736

…y_doc/source/whatsnew5

datapythonista approved these changes May 6, 2020

View reviewed changes

WillAyd approved these changes May 6, 2020

View reviewed changes

WillAyd merged commit 0d3c5ce into pandas-dev:master May 6, 2020

rhshadrach pushed a commit to rhshadrach/pandas that referenced this pull request May 10, 2020

DOC: Fix heading capitalization in doc/source/whatsnew - part5 (panda…

5421d46

…s-dev#32550) (pandas-dev#33568)

	Method ``merge_asof`` for asof-style time-Series joining
	Function ``merge_asof`` for asof-style time-Series joining

	Method ``PeriodIndex`` now has ``Period`` dtype
	The ``PeriodIndex`` now has ``Period`` dtype

	Method ``read_csv`` will progressively enumerate chunks
	Function ``read_csv`` will progressively enumerate chunks

	Method ``.GroupBy(..)`` syntax with window and resample operations
	Method ``.groupby(..)`` syntax with window and resample operations

		@@ -306,8 +306,8 @@ API changes

		.. _whatsnew_0181.api.groubynth:

Uh oh!

DOC: Fix heading capitalization in doc/source/whatsnew - part5 (#32550) #33568

DOC: Fix heading capitalization in doc/source/whatsnew - part5 (#32550) #33568

Uh oh!

Conversation

cleconte987 commented Apr 15, 2020

Uh oh!

WillAyd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cleconte987 commented Apr 16, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azure-pipelines bot commented Apr 19, 2020

Uh oh!

cleconte987 commented Apr 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

cleconte987 commented May 5, 2020

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

cleconte987 commented May 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WillAyd commented May 6, 2020

Uh oh!

Uh oh!

cleconte987 commented Apr 19, 2020 •

edited

Loading

cleconte987 commented May 6, 2020 •

edited

Loading