Skip to content
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

Improved release notes #3324

Merged
merged 3 commits into from
May 11, 2019
Merged

Improved release notes #3324

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
306650c
Add paragraph about visual changes. Fixes #3304.
clauswilke May 10, 2019
5e4c3fa
add breaking changes section
clauswilke May 11, 2019
e77e4b9
provided explicit examples of where things go wrong.
clauswilke May 11, 2019
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
6 changes: 6 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ extension developers if they have relied on internals that have been changed.
This release also sees the addition of Hiroaki Yutani (@yutannihilation) to the
core developer team.

Two patches (#2996 and #3050) fixed minor rendering problems. In most cases, the
Copy link
Member

Choose a reason for hiding this comment

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

Maybe put under ## Breaking changes?

Copy link
Member Author

@clauswilke clauswilke May 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

That works for me. I remember we had some discussion in the past about what exactly a breaking change is, but it feels like a breaking change to me. I also added a bullet point where I'm trying to express that ggplot2 is now somewhat stricter and now creates errors or warnings where previously it would just create some arbitrary output. Not sure I'm totally happy with the wording. I'm referring to issues such as #3316, #3305, #3318.

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 added the specific examples to the bullet point. I think that makes it better.

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 say that breaking a revdep check is sufficient (but not necessary) for a change to be breaking.

visual changes are so subtle that they are difficult to see with the naked eye.
However, these changes are detected by the vdiffr package, and therefore any
package developers who use vdiffr to test for visual correctness of ggplot2 plots
will have to regenerate all reference images.

## New features

* This release includes a range of internal changes that speeds up plot
Expand Down