Skip to content

fix up NEWS.md for release #2921

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.

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 2 commits into from
Oct 1, 2018
Merged

Conversation

clauswilke
Copy link
Member

I have taken a first stab at NEWS.md.

@hadley According to the style guide, package authors should not be listed for items they wrote. Do you want me to remove @clauswilke and @karawoo from all 3.1.0 news items? (I think no other contributors are official authors.)

@hadley
Copy link
Member

hadley commented Oct 1, 2018

I don't mind either way about authorship — when I wrote that advice, I was mostly thinking of my team at RStudio.

@clauswilke
Copy link
Member Author

@hadley Ok, then I'll leave them in.

@batpigandme Any copy edits from your side?

Copy link
Contributor

@batpigandme batpigandme left a comment

Choose a reason for hiding this comment

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

Couple wording changes, and some suggestions that you can feel free to disregard if they sound off to you.

(@clauswilke, #2846).
This is a minor release and breaking changes have been kept to a minimum. End users of ggplot2 are unlikely to encounter any issues. However, there are a few items that developers of ggplot2 extensions should be aware of. For additional details, see also the discussion accompanying issue #2890.

* In non-user-facing internal code (specifically in the `aes()` function and in
Copy link
Contributor

Choose a reason for hiding this comment

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

Switch "of" to "for" for "British spelling for aesthetics…"? (I had a split second of wondering how the British spell the word of aesthetics)

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok.

NEWS.md Outdated
* In non-user-facing internal code (specifically in the `aes()` function and in
the `aesthetics` argument of scale functions), ggplot2 now always uses the British
spelling of aesthetics containing the word "colour". When users specify a "color"
aesthetic it is automatically renamed to "colour". This principle is also applied
Copy link
Contributor

Choose a reason for hiding this comment

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

Simplify the "This principle is also…" to "This also applies to non-standard aesthetics…" ?
(stylistic, it's fine either way)

Copy link
Member Author

Choose a reason for hiding this comment

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

I normally try to avoid using "this" as a pronoun (as opposed to a modifier), as it leads to imprecise writing. But I agree that "this principle" is awkward, so maybe imprecise is better here.

Copy link
Member Author

@clauswilke clauswilke Oct 1, 2018

Choose a reason for hiding this comment

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

I think "this renaming" works better than just "this":

When users specify a "color" aesthetic it is automatically renamed to "colour". This renaming is also applied to non-standard aesthetics that contain the word "color".

versus:

When users specify a "color" aesthetic it is automatically renamed to "colour". This is also applied to non-standard aesthetics that contain the word "color".

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure. 👍

NEWS.md Outdated
aesthetic it is automatically renamed to "colour". This principle is also applied
to non-standard aesthetics that contain the word "color". For example, "point_color"
is renamed to "point_colour". This convention makes it easier to support both
British and American spelling for novel non-standard aesthetics, but it may require
Copy link
Contributor

Choose a reason for hiding this comment

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

Comma after novel? (though I guess non-standard aesthetics could be considered the noun phrase — so, again, tossup!)

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok.

is renamed to "point_colour". This convention makes it easier to support both
British and American spelling for novel non-standard aesthetics, but it may require
some adjustment for packages that have previously introduced non-standard color
aesthetics using American spelling. A new function `standardise_aes_names()` is
Copy link
Contributor

Choose a reason for hiding this comment

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

Style-wise, I think the goal has been to have the new function near the front of the bullet (see http://style.tidyverse.org/news.html#common-patterns), but I get why it's not in this case.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I think I'll leave it as is.

NEWS.md Outdated

* `benchplot()` now uses tidy evaluation (@dpseidel, #2699).

* The error message in `compute_aesthetics()` now provides the names of only
Copy link
Contributor

Choose a reason for hiding this comment

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

Awk word ordering here, maybe change to: "now only provides the names of aesthetics…" or "now returns the names only for aesthetics…"

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, thanks!

@clauswilke clauswilke merged commit bc46ba6 into tidyverse:master Oct 1, 2018
@clauswilke clauswilke deleted the 3.1.0-release-NEWS branch October 1, 2018 17:37
@clauswilke clauswilke mentioned this pull request Mar 27, 2019
@lock
Copy link

lock bot commented Mar 30, 2019

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/

@lock lock bot locked and limited conversation to collaborators Mar 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants