Skip to content

Changelog entry for v0.6.0 #1808

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 8 commits into from
Mar 14, 2022
Merged

Changelog entry for v0.6.0 #1808

merged 8 commits into from
Mar 14, 2022

Conversation

maxrjones
Copy link
Member

@maxrjones maxrjones commented Mar 13, 2022

Description of proposed changes

This PR adds a changelog entry for v0.6.0.

Preview: https://pygmt-git-changelog-release-gmt.vercel.app/changes.html

Previous release at #1594

Changelog made by following the instructions at https://github.com/GenericMappingTools/pygmt/blob/main/doc/maintenance.md#updating-the-changelog

TODO:

Relates to #1801

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@maxrjones maxrjones added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Mar 13, 2022
@weiji14 weiji14 mentioned this pull request Mar 13, 2022
28 tasks
@seisman seisman added this to the 0.6.0 milestone Mar 13, 2022
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Thanks for drafting this up Meghan (and really sorry for taking up your weekend). This is in pretty good shape already, but I'd like someone else to take a stab at the highlights. It feels like we're underselling what's changed in the past 5 months!

doc/changes.md Outdated
@@ -1,5 +1,92 @@
# Changelog

## Release v0.6.0 (20YY/MM/DD)
Copy link
Member

Choose a reason for hiding this comment

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

Putting down Monday here (UTC time) just in case, but I'm hoping to get this over by Sunday in the US if possible.

Suggested change
## Release v0.6.0 (20YY/MM/DD)
## Release v0.6.0 (2022/03/14)

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 think we should edit #1801 to 03/14 to give opportunities for comments at #731 and #1812. It would've been nice to wrap this up today (really missing that extra hour), but a PI day release could also be fun.

Copy link
Member

@weiji14 weiji14 Mar 13, 2022

Choose a reason for hiding this comment

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

Oo yes, definitely do 3/14! I just realized we'll have 3 new functions (grdhisteq, triangulate, pygmt.datasets.load_sample_data) and 14 inline examples (if we merge in just one of #1719 or #1729) 😆

Edit: And here's a Pi-Day plot adapted from https://www.pygmt.org/v0.5.0/gallery/symbols/text_symbols.html

pi_day

Copy link
Member Author

Choose a reason for hiding this comment

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

The plot is really nice. Do you mind sharing your code? I'd be interested in trying a couple adjustments.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, @weiji14 would you be willing to do the Twitter post for the release? That plot would be great for it 😄

Copy link
Member

@weiji14 weiji14 Mar 14, 2022

Choose a reason for hiding this comment

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

Sure, I can do the twitter post. I was thinking of putting it in the forum post but couldn't find a good place to put it. The code is:

import pygmt

fig = pygmt.Figure()
fig.basemap(region=[0, 8, 0, 3], projection="X12c/4c", frame=True)

pen = "1.5p"
fig.plot(x=1, y=1.5, style="l3.5c+t3", color="dodgerblue3", pen=pen)
fig.plot(x=2, y=1, style="l3.5c+t.", color="red3", pen=pen)
fig.plot(x=3, y=1.5, style="l3.5c+t1+fCourier-Bold", color="seagreen", pen=pen)
fig.plot(x=4.3, y=1.5, style="l3.5c+t4+fTimes-Italic", color="gold", pen=pen)
fig.plot(x=5.6, y=1.5, style="l3.5c+t1+fBookman-Light", color="pink", pen=pen)
fig.plot(x=7, y=1.5, style="l3.5c+t\160+fSymbol,darkorange", color="magenta4", pen=pen)

fig.show()

@maxrjones
Copy link
Member Author

This is in pretty good shape already, but I'd like someone else to take a stab at the highlights. It feels like we're underselling what's changed in the past 5 months!

I agree. @willschlitzer, do you have any thoughts on the highlights? I know some of your implemented features are still pending (sorry for the slow reviews), but since you've put a lot of work in since the last release it would be great to get your opinions on this.

@willschlitzer
Copy link
Contributor

This is in pretty good shape already, but I'd like someone else to take a stab at the highlights. It feels like we're underselling what's changed in the past 5 months!

I agree. @willschlitzer, do you have any thoughts on the highlights? I know some of your implemented features are still pending (sorry for the slow reviews), but since you've put a lot of work in since the last release it would be great to get your opinions on this.

Looks good to me! Only change I would consider is that dataset loading function under the highlights section instead of the new feature: I think that's a pretty big (and positive!) change.

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Ok from me, but ping @GenericMappingTools/pygmt-maintainers for a second (or third) approval.

@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Mar 14, 2022
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

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

Except the minor typo, everything looks great! Thanks everybody.

Co-authored-by: Michael Grund <[email protected]>
@maxrjones maxrjones merged commit af1382f into main Mar 14, 2022
@maxrjones maxrjones deleted the changelog-release branch March 14, 2022 18:01
@maxrjones maxrjones removed the final review call This PR requires final review and approval from a second reviewer label Mar 14, 2022
@seisman seisman mentioned this pull request Apr 9, 2022
8 tasks
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
* Add new entry in version_switch.js

* Draft changelog for v0.6.0

* Add v0.6.0 to compatibility table

* Update author lists

* Apply suggestions from code review

Co-authored-by: Wei Ji <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants