Skip to content

DOC: Fix capitalisation in doc/source/whatsnew - part1 (issue #32550) #33382

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

Merged
merged 11 commits into from
Apr 11, 2020
Merged

DOC: Fix capitalisation in doc/source/whatsnew - part1 (issue #32550) #33382

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8afa747
Modify files in doc/source/whatsnew
cleconte987 Apr 7, 2020
756349b
Merge remote-tracking branch 'upstream_main_pandas/master' into modif…
cleconte987 Apr 7, 2020
c8eeb3c
Changing again files to be in order with correct style requirements
cleconte987 Apr 8, 2020
a58c503
Merge remote-tracking branch 'upstream_main_pandas/master' into modif…
cleconte987 Apr 8, 2020
72ac0d4
Adding 'Versions' at the beginning of the heading line 3 in file 'do…
cleconte987 Apr 8, 2020
bdd4c2a
Further modifications
cleconte987 Apr 8, 2020
b5f6902
Merge remote-tracking branch 'upstream_main_pandas/master' into modif…
cleconte987 Apr 8, 2020
c873fdc
Correct headings capitalization by replacing 'Version v.X.X.X' by 'Ve…
cleconte987 Apr 8, 2020
31e3600
Merge remote-tracking branch 'upstream_main_pandas/master' into modif…
cleconte987 Apr 8, 2020
abeecc7
Regularize line length below heading
cleconte987 Apr 8, 2020
00b016e
Fix conflicts in file 'scripts/validate_rst_title_capitalization.py' …
cleconte987 Apr 10, 2020
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/whatsnew/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{ header }}

*************
Release Notes
Release notes
*************

This is the list of changes to pandas between each release. For full details,
Expand Down
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v0.4.x.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _whatsnew_04x:

v.0.4.1 through v0.4.3 (September 25 - October 9, 2011)
Versions v.0.4.1 through v0.4.3 (September 25 - October 9, 2011)
Copy link
Member

Choose a reason for hiding this comment

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

We can fix this since we're here.

Suggested change
Versions v.0.4.1 through v0.4.3 (September 25 - October 9, 2011)
Versions v.0.4.1 through v.0.4.3 (September 25 - October 9, 2011)

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

-------------------------------------------------------
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 make these lines the same length as the title please? Other than that looks good to me.

@TomAugspurger are you ok using Version 1.0.3 in the what's new titles, instead of v1.0.3? We're applying the script to keep titles consistent in all docs, and the v1.0.3 format will require complicating the script significantly to be handled. In some cases it'll appear at the beginning, and the script will expect V1.0.3, and in others it's in the middle. We can define exceptions in the script, but we should add every existing version there, and keep adding the future ones. Which seems a worse solution than just using Version 1.0.3.

Copy link
Contributor

Choose a reason for hiding this comment

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

Version 1.0.3 seems fine.


{{ header }}
Expand Down
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v0.5.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

.. _whatsnew_050:

v.0.5.0 (October 24, 2011)
V.0.5.0 (October 24, 2011)
Copy link
Member

Choose a reason for hiding this comment

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

I'd be consistent.

Suggested change
V.0.5.0 (October 24, 2011)
Version v.0.5.0 (October 24, 2011)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah! Ok I didn't understand what you meant. Correcting

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

{{ header }}
Expand Down
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v0.6.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _whatsnew_060:

v.0.6.0 (November 25, 2011)
V.0.6.0 (November 25, 2011)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
V.0.6.0 (November 25, 2011)
Version v.0.6.0 (November 25, 2011)

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

{{ header }}
Expand Down
12 changes: 12 additions & 0 deletions scripts/validate_rst_title_capitalization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,18 @@
"BusinessHour",
"BusinessDay",
"DateOffset",
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December",
}

CAP_EXCEPTIONS_DICT = {word.lower(): word for word in CAPITALIZATION_EXCEPTIONS}
Expand Down