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.

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

Mention breaking change regarding extra quotation marks around text strings in changelog v0.12.0 #3462

Merged
merged 3 commits into from
Sep 28, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Sep 27, 2024

Mention a breaking change regarding how text wrapped by extra quotation marks is handled in the changelog v0.12.0. The change was introduced in #3132 (went into v0.12.0). However it was not recognized, but now it is reported in #3457 (after v0.13.0 was released). For details, please see #3457 (comment).

So far, it is listed under "Enhancements" as the related PR #3132 is also listed there. The formulation is a first suggestion.

Fixes #3457

Preview: https://pygmt-dev--3462.org.readthedocs.build/en/3462/changes.html#id2

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation deprecation Deprecating a feature labels Sep 27, 2024
@seisman seisman added this to the 0.14.0 milestone Sep 27, 2024
doc/changes.md Outdated Show resolved Hide resolved
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed deprecation Deprecating a feature labels Sep 28, 2024
@weiji14 weiji14 added the skip-changelog Skip adding Pull Request to changelog label Sep 28, 2024
doc/changes.md Outdated
@@ -101,6 +101,7 @@

### Enhancements

* **Breaking**: (Unneeded) extra quotation marks around text strings (containing whitespaces) are now considered as part of the text string ([#3132](https://github.com/GenericMappingTools/pygmt/pull/3132), [#3457](https://github.com/GenericMappingTools/pygmt/issues/3457))
Copy link
Member

@weiji14 weiji14 Sep 28, 2024

Choose a reason for hiding this comment

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

Do we need to be specific that it is double quotes " " that will show up after v0.12.0?

Suggested change
* **Breaking**: (Unneeded) extra quotation marks around text strings (containing whitespaces) are now considered as part of the text string ([#3132](https://github.com/GenericMappingTools/pygmt/pull/3132), [#3457](https://github.com/GenericMappingTools/pygmt/issues/3457))
* **Breaking**: (Unneeded) extra double quotes around text strings (containing whitespaces) are now considered as part of the text string ([#3132](https://github.com/GenericMappingTools/pygmt/pull/3132), [#3457](https://github.com/GenericMappingTools/pygmt/issues/3457))

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm. In principle both comibinations (" ' ' " , ' " " ') are possible and working:

import pygmt 

size = 1
title = "my title"

fig = pygmt.Figure()
fig.basemap(region=[-size, size] * 2, projection="X5c/1c", frame=[f'WSne+t"this is {title}"'])
fig.shift_origin(xshift="+w+1c")
fig.basemap(region=[-size, size] * 2, projection="X5c/1c", frame=[f"WSne+t'this is {title}'"])
fig.show()

text_whitespace_quotationmarks_included

Copy link
Member

Choose a reason for hiding this comment

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

As shown in #3457 (comment), single quotes are part of the text string since the first PyGMT version, so it's not considered to be a breaking change in v0.12.0.

Copy link
Member Author

@yvonnefroehlich yvonnefroehlich Sep 28, 2024

Choose a reason for hiding this comment

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

Ah, OK. Then adjustment of the formulation is fair and makes sense.

@seisman seisman removed skip-changelog Skip adding Pull Request to changelog final review call This PR requires final review and approval from a second reviewer labels Sep 28, 2024
@seisman seisman merged commit 911f56b into main Sep 28, 2024
8 of 9 checks passed
@seisman seisman deleted the add-breaking-change-text-v0120 branch September 28, 2024 07:08
@seisman
Copy link
Member

seisman commented Sep 28, 2024

I've removed the "skip-changelog" label from this PR. After this PR is merged, an entry will be added to the v0.14.0 draft changelog, which will remind us to mention this "breaking change in v0.12.0" when releasing v0.14.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Breaking change in how text strings are treated
3 participants