-
Notifications
You must be signed in to change notification settings - Fork 224
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
Conversation
…trings in changelog v0120
Co-authored-by: Dongdong Tian <[email protected]>
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)) |
There was a problem hiding this comment.
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?
* **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)) |
There was a problem hiding this comment.
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()
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Co-authored-by: Wei Ji <[email protected]>
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. |
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