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

Jump to bottom
Merged
merged 11 commits into from
Apr 11, 2020
Merged

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

merged 11 commits into from
Apr 11, 2020

Conversation

cleconte987
Copy link
Contributor

  • modify files index.rst, v0.4.x.rst, v0.5.0.rst, v0.6.0.rst

  • passes black pandas

  • passes git diff upstream/master -u -- "*.py" | flake8 --diff

@cleconte987
Copy link
Contributor Author

Should version numbers begin with a capital 'v' or not?

mroeschke
mroeschke reviewed Apr 8, 2020
View reviewed changes
doc/source/whatsnew/v0.4.x.rst Outdated
@@ -1,6 +1,6 @@
.. _whatsnew_04x:

v.0.4.1 through v0.4.3 (September 25 - October 9, 2011)
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.

I think the months should still be capitalized as proper nouns? cc @datapythonista

Copy link
Member

Choose a reason for hiding this comment

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

Yes, afaik in English they should be capitalized.

@cleconte987 do you mind adding all month names to the list of exceptions please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, doing it now.

@datapythonista datapythonista changed the title Fix capitalisation in doc/source/whatsnew - part1 (issue #32550) DOC: Fix capitalisation in doc/source/whatsnew - part1 (issue #32550) Apr 8, 2020
datapythonista
datapythonista reviewed Apr 8, 2020
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.

I think version numbers are ok in lowercase, but if that fails the script and complicates things too much, I guess in upper case would also be ok.

@cleconte987
Copy link
Contributor Author

I think version numbers are ok in lowercase, but if that fails the script and complicates things too much, I guess in upper case would also be ok.

Ok so changing it to uppercase

@datapythonista
Copy link
Member

Ok so changing it to uppercase

Just realized that we'll be capitalizing the first one of V0.4.1 through v0.4.3, which I think it's not great. May be we can use Versions v0.4.1 through v0.4.3 or something similar instead?

@cleconte987
Copy link
Contributor Author

Ok so changing it to uppercase

Just realized that we'll be capitalizing the first one of V0.4.1 through v0.4.3, which I think it's not great. May be we can use Versions v0.4.1 through v0.4.3 or something similar instead?

Ok changing it to "Versions ..."

datapythonista
datapythonista reviewed Apr 8, 2020
View reviewed changes
doc/source/whatsnew/v0.4.x.rst Outdated
@@ -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

doc/source/whatsnew/v0.5.0.rst Outdated
@@ -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

doc/source/whatsnew/v0.6.0.rst Outdated
@@ -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)

@datapythonista
Copy link
Member

Looks like in recent versions we use v0.0.0 instead of v.0.0.0. But I think if we add the word version, we can actually get rid of the v, and just leave Version 0.6.0... What do you think?

@cleconte987
Copy link
Contributor Author

Looks like in recent versions we use v0.0.0 instead of v.0.0.0. But I think if we add the word version, we can actually get rid of the v, and just leave Version 0.6.0... What do you think?

For me it would be ok. But Im not in the project enough to know if it would make sense

datapythonista
datapythonista reviewed Apr 8, 2020
View reviewed changes
doc/source/whatsnew/v0.4.x.rst Outdated
@@ -1,6 +1,6 @@
.. _whatsnew_04x:

v.0.4.1 through v0.4.3 (September 25 - October 9, 2011)
Versions 0.4.1 through 0.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.

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.

datapythonista
datapythonista approved these changes Apr 9, 2020
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.

lgtm. thanks for the fixes @cleconte987

@cleconte987
Copy link
Contributor Author

You're welcome!

@jreback jreback added this to the 1.1 milestone Apr 10, 2020
@jreback
Copy link
Contributor

jreback commented Apr 10, 2020

can merge master and ping on green.

@cleconte987
Copy link
Contributor Author

@jreback
Updated, merged master.

@datapythonista datapythonista merged commit d1cba24 into pandas-dev:master Apr 11, 2020
@datapythonista
Copy link
Member

Thanks @cleconte987

jbrockmendel pushed a commit to jbrockmendel/pandas that referenced this pull request Apr 14, 2020
@cleconte987 @jbrockmendel
DOC: Fix capitalisation in doc/source/whatsnew - part1 (issue pandas-…
5bd6141 
…dev#32550) (pandas-dev#33382)
@cleconte987
Copy link
Contributor Author

Thanks @cleconte987

You're welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAugspurger TomAugspurger TomAugspurger left review comments

@mroeschke mroeschke mroeschke left review comments

@datapythonista datapythonista datapythonista approved these changes

Assignees
No one assigned
Labels
Clean Docs
Projects
None yet
Milestone
1.1
Development

Successfully merging this pull request may close these issues.
5 participants
@cleconte987 @datapythonista @jreback @TomAugspurger @mroeschke