From ccb9aa8a43ddb4212020199e1564cc64a56c2525 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 14 Feb 2021 07:40:15 +0000 Subject: [PATCH 01/18] Add v0.3.0 to version_switch.js --- doc/_static/version_switch.js | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/_static/version_switch.js b/doc/_static/version_switch.js index 1ae53e65dd0..0d3df020b4c 100644 --- a/doc/_static/version_switch.js +++ b/doc/_static/version_switch.js @@ -12,6 +12,7 @@ var all_versions = { 'latest': 'latest', 'dev': 'dev', + 'v0.3.0': 'v0.3.0', 'v0.2.1': 'v0.2.1', 'v0.2.0': 'v0.2.0', 'v0.1.2': 'v0.1.2', From 9fe24fbc95e3ef85e3d0e790a26c5c55348e86ad Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 14 Feb 2021 07:53:09 +0000 Subject: [PATCH 02/18] Update citation information --- README.rst | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 24bed6ef5a7..b0f57679b58 100644 --- a/README.rst +++ b/README.rst @@ -153,20 +153,23 @@ Developers". Feel free to cite our work in your research using the following Bib .. code-block:: - @software{uieda_leonardo_2020_4025418, + @software{pygmt_2021_4522136, author = {Uieda, Leonardo and Tian, Dongdong and Leong, Wei Ji and Toney, Liam and + Schlitzer, William and + Grund, Michael and Newton, Tyler and + Jones, Meghan and Wessel, Paul}, title = {{PyGMT: A Python interface for the Generic Mapping Tools}}, - month = nov, - year = 2020, + month = feb, + year = 2021, publisher = {Zenodo}, - version = {v0.2.1}, - doi = {10.5281/zenodo.4253459}, - url = {https://doi.org/10.5281/zenodo.4253459} + version = {v0.3.0}, + doi = {10.5281/zenodo.4522136}, + url = {https://doi.org/10.5281/zenodo.4522136} } To cite a specific version of PyGMT, go to our Zenodo page at From 1081fb271dda018a1050b8854344767aebfb5599 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 14 Feb 2021 09:49:47 +0000 Subject: [PATCH 03/18] Update compatibility and doicumentation links --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b0f57679b58..9c0b95a030b 100644 --- a/README.rst +++ b/README.rst @@ -215,6 +215,7 @@ Documentation for other versions * `Development `__ (reflects the *master* branch on GitHub) * `Latest release `__ +* `v0.3.0 `__ * `v0.2.1 `__ * `v0.2.0 `__ * `v0.1.2 `__ @@ -228,7 +229,8 @@ Compatibility with Python and GMT versions ======= ========== ========= PyGMT GMT Python ======= ========== ========= -0.2.1 >=6.1.1 >=3.6 +0.3.0 >=6.1.1 >=3.6 +0.2.1 >=6.1.1 3.6 - 3.9 0.2.0 >=6.1.1 3.6 - 3.8 0.1.x >=6.0.0 3.6 - 3.8 ======= ========== ========= From 6ec6a3a4b526a2ee7bbb2085bdf7bf6cf22eebf3 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 14 Feb 2021 18:36:12 +0000 Subject: [PATCH 04/18] Apply suggestions from code review Co-authored-by: Dongdong Tian --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 9c0b95a030b..fb3eca748ae 100644 --- a/README.rst +++ b/README.rst @@ -229,8 +229,8 @@ Compatibility with Python and GMT versions ======= ========== ========= PyGMT GMT Python ======= ========== ========= -0.3.0 >=6.1.1 >=3.6 -0.2.1 >=6.1.1 3.6 - 3.9 +0.3.0 >=6.1.1 >=3.7 +0.2.1 >=6.1.1 >=3.6 0.2.0 >=6.1.1 3.6 - 3.8 0.1.x >=6.0.0 3.6 - 3.8 ======= ========== ========= From 36b72e9cc1aedecb289ee0bbe2fb19cdaa7eecb9 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Mon, 15 Feb 2021 13:13:00 +1300 Subject: [PATCH 05/18] Initial draft changelog from Release Drafter --- doc/changes.rst | 123 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 123 insertions(+) diff --git a/doc/changes.rst b/doc/changes.rst index a65f64af3a7..4c7faac6ab8 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -1,6 +1,127 @@ Changelog ========= +Release v0.3.0 (2021/02/15) +--------------------------- + +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4522136.svg + :alt: Digital Object Identifier for the Zenodo archive + :target: https://doi.org/10.5281/zenodo.4522136 + +Highlights + +* + +New Features + +* Wrap subplot using with statement (#822) +* Wrap grd2cpt (#803) +* Wrap inset (#788) +* Let Figure.text() support record-by-record transparency (#716) +* Provide basic support for FreeBSD (#700) + +Enhancements + +* Let load_earth_relief() support 'region' argument for all resolutions (#873) +* Detect ghostscript and default image viewer in FreeBSD (#878) +* Improve how PyGMT finds the GMT library (#702) +* Add dcw alias (E) to Figure.coast (#765) +* Add lakes alias to Figure.coast() (#781) +* Add the shading parameter to colorbar() in base_plotting.py (#752) + +Documentation + +* Update the docstrings in the plotting modules (#881) +* Update the doc strings in the non-plotting modules (#882) +* Add alias annotation (A) to Figure.contour() (#883) +* Revise pygmt development installation instructions (#865) +* Update the docstrings of common aliases (#862) +* Add common alias panel (-c) to all plotting functions (#853) +* Update forum link to pygmt specific category (#858) +* Wrap grdinfo aliases (#799) +* Add sphinx-copybutton extension to easily copy codes (#838) +* Add additional video link in text for clarity (#836) +* Choosing the thumbnail figures in tutorials (#826) +* Add a gallery example for logo (#823) +* Update axis label explanation in frames tutorial (#820) +* Update GMT arguments in coast doc strings (#798) +* Add tutorial for region arguments (#800) +* Add guidelines for types of tests to write (#796) +* Recommend using SI units in documentation (#795) +* Update GMT argument in the miscellaneous projections gallery to doc standards (#790) +* Update GMT argument in the cylindric projections gallery to doc standards (#789) +* Create gallery example for datetime inputs (#779) +* Update GMT argument in the conic projections gallery to doc standards (#780) +* Update GMT argument in the azimuthal projections gallery to doc standards (#776) +* Add an example for plotting multi-parameter symbols (#772) +* Add a gallery example for the fig.image() method (#777) +* Add a gallery example of setting line colors with a custom CPT (#774) +* Add a table for compatibility of PyGMT with Python and GMT (#763) +* Add description for the "columns" arguments (#766) +* Add logarithmic and power projections (#742) +* Add table for projections (#753) +* Add miscellaneous projections descriptions (#762) +* Add cylindric descriptions (#761) +* Conic projection descriptions (#757) +* Add projection description for Lambert Azimuthal Equal-Area (#760) +* Add tutorial for 3D perspective image (#743) +* Add plotting lines tutorial (#741) +* Change text when GMTInvalidInput error is raised for basemap (#729) +* Add non-geographic plots to projection gallery (#728) +* Adding cylindrical projections to gallery (#727) +* Add tutorial for adding a map title (#720) +* Adding miscellaneous projections to gallery (#723) +* Add conic projections to the projection gallery (#721) +* Add tutorial for plotting Earth relief (#712) +* Add frame and cmap to the colorbar parameters list (#709) +* Add tutorial for contour maps (#705) +* Add frame as a parameter on the grdview documentation (#707) + +Bug Fixes + +* Fix a bug of Figure.text() when "text" is a non-string array (#724) +* Fix the error message when IPython is not available (#701) + +Maintenance + +* Add dependabot to keep GitHub Actions up to date (#861) +* Add authorship policy (#726) +* Move plotting functions to separate modules (#808) +* Skip workflows in PRs if only non-source-code files are changed (#839) +* Move non-plotting modules to separate files in src directory (#832) +* Show test execution times in pytest (#835) +* Add slash command '/test-gmt-dev' to test GMT dev version (#831) +* Add tests for grdfilter (#809) +* Improve the error message when PyGMT fails to load the GMT library (#814) +* Add tests for GMTInvalidInput for figure.py (#810) +* Split meca into a standalone module from base_plotting.py (#686) +* Update CONTRIBUTING.md with formatting conventions (#775) +* Use args_in_kwargs for basemap error raising (#797) +* Add docformatter to format plain text in docstrings (#642) +* Add GMTInvalidInput Error for Figure.coast (#787) +* Add args_in_kwargs function (#791) +* Add a CI job testing GMT master branch on Windows (#756) +* Add isort to sort imports alphabetically (#745) +* Convert relative imports to absolute imports (#754) +* Add a Makefile target 'distclean' for deleting project metadata files (#744) +* Add test test_basemap_map_scale (#739) +* Check files for UNIX-style line breaks and 644 permission (#736) +* Rename vercel configuration file from now.json to vercel.json (#738) +* Migrate pytest configurations to pyproject.toml (#725) +* Migrate documentation deployment from Travis CI to GitHub Actions (#713) +* Switch from versioneer to setuptools-scm (#695) +* Migrate coverage configurations to pyproject.toml (#667) + +Deprecations + +* Drop Python 3.6 support (#699) + +Contributors + +@dependabot, @dependabot[bot], @liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer + +---- + Release v0.2.1 (2020/11/14) --------------------------- @@ -76,6 +197,8 @@ This release contains contributions from: * `Conor Bacon `__ * `carocamargo `__ +---- + Release v0.2.0 (2020/09/12) --------------------------- From 29cbefc0ebb86c8c16df3b661a034e33cc519ce2 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Mon, 15 Feb 2021 13:22:40 +1300 Subject: [PATCH 06/18] Merge some changelog entries together Co-Authored-By: Will Schlitzer --- doc/changes.rst | 28 ++++++---------------------- 1 file changed, 6 insertions(+), 22 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 4c7faac6ab8..36d2782898a 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -14,9 +14,7 @@ Highlights New Features -* Wrap subplot using with statement (#822) -* Wrap grd2cpt (#803) -* Wrap inset (#788) +* Wrap grd2cpt (#803), inset (#788), and subplot (#822) * Let Figure.text() support record-by-record transparency (#716) * Provide basic support for FreeBSD (#700) @@ -25,8 +23,7 @@ Enhancements * Let load_earth_relief() support 'region' argument for all resolutions (#873) * Detect ghostscript and default image viewer in FreeBSD (#878) * Improve how PyGMT finds the GMT library (#702) -* Add dcw alias (E) to Figure.coast (#765) -* Add lakes alias to Figure.coast() (#781) +* Add dcw (#765) and lakes (#781) aliases to Figure.coast * Add the shading parameter to colorbar() in base_plotting.py (#752) Documentation @@ -45,36 +42,23 @@ Documentation * Add a gallery example for logo (#823) * Update axis label explanation in frames tutorial (#820) * Update GMT arguments in coast doc strings (#798) -* Add tutorial for region arguments (#800) * Add guidelines for types of tests to write (#796) * Recommend using SI units in documentation (#795) -* Update GMT argument in the miscellaneous projections gallery to doc standards (#790) -* Update GMT argument in the cylindric projections gallery to doc standards (#789) * Create gallery example for datetime inputs (#779) -* Update GMT argument in the conic projections gallery to doc standards (#780) -* Update GMT argument in the azimuthal projections gallery to doc standards (#776) +* Update GMT argument in the azimuthal (#776), conic (#780), cylindric (#789), and miscellaneous (#790) projections gallery to doc standards * Add an example for plotting multi-parameter symbols (#772) * Add a gallery example for the fig.image() method (#777) * Add a gallery example of setting line colors with a custom CPT (#774) * Add a table for compatibility of PyGMT with Python and GMT (#763) * Add description for the "columns" arguments (#766) -* Add logarithmic and power projections (#742) * Add table for projections (#753) -* Add miscellaneous projections descriptions (#762) -* Add cylindric descriptions (#761) -* Conic projection descriptions (#757) +* Add cylindric (#761), conic projection (#721, #757), miscellaneous projections descriptions (#723, #762), logarithmic and power projections (#742) to gallery * Add projection description for Lambert Azimuthal Equal-Area (#760) -* Add tutorial for 3D perspective image (#743) -* Add plotting lines tutorial (#741) * Change text when GMTInvalidInput error is raised for basemap (#729) * Add non-geographic plots to projection gallery (#728) * Adding cylindrical projections to gallery (#727) -* Add tutorial for adding a map title (#720) -* Adding miscellaneous projections to gallery (#723) -* Add conic projections to the projection gallery (#721) -* Add tutorial for plotting Earth relief (#712) +* Add tutorials, for adding a map title (#720), plotting Earth relief (#712), 3D perspective image (#743), contour maps (#705), plotting lines tutorial (#741), region arguments (#800) * Add frame and cmap to the colorbar parameters list (#709) -* Add tutorial for contour maps (#705) * Add frame as a parameter on the grdview documentation (#707) Bug Fixes @@ -118,7 +102,7 @@ Deprecations Contributors -@dependabot, @dependabot[bot], @liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer +@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer ---- From 4122c73c3472deb6b361619f1d2c40838e1d6cef Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Mon, 15 Feb 2021 15:58:43 +1300 Subject: [PATCH 07/18] Apply suggestions from code review Co-authored-by: Dongdong Tian --- README.rst | 1 + doc/changes.rst | 12 ++++-------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index fb3eca748ae..806fecd5be9 100644 --- a/README.rst +++ b/README.rst @@ -161,6 +161,7 @@ Developers". Feel free to cite our work in your research using the following Bib Schlitzer, William and Grund, Michael and Newton, Tyler and + Ziebarth, Malte and Jones, Meghan and Wessel, Paul}, title = {{PyGMT: A Python interface for the Generic Mapping Tools}}, diff --git a/doc/changes.rst b/doc/changes.rst index 36d2782898a..a0810272147 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -16,15 +16,14 @@ New Features * Wrap grd2cpt (#803), inset (#788), and subplot (#822) * Let Figure.text() support record-by-record transparency (#716) -* Provide basic support for FreeBSD (#700) +* Provide basic support for FreeBSD (#700, #878) Enhancements -* Let load_earth_relief() support 'region' argument for all resolutions (#873) -* Detect ghostscript and default image viewer in FreeBSD (#878) +* Let load_earth_relief() support the 'region' parameter for all resolutions (#873) * Improve how PyGMT finds the GMT library (#702) * Add dcw (#765) and lakes (#781) aliases to Figure.coast -* Add the shading parameter to colorbar() in base_plotting.py (#752) +* Add the shading parameter to Figure.colorbar (#752) Documentation @@ -34,10 +33,8 @@ Documentation * Revise pygmt development installation instructions (#865) * Update the docstrings of common aliases (#862) * Add common alias panel (-c) to all plotting functions (#853) -* Update forum link to pygmt specific category (#858) * Wrap grdinfo aliases (#799) * Add sphinx-copybutton extension to easily copy codes (#838) -* Add additional video link in text for clarity (#836) * Choosing the thumbnail figures in tutorials (#826) * Add a gallery example for logo (#823) * Update axis label explanation in frames tutorial (#820) @@ -45,14 +42,13 @@ Documentation * Add guidelines for types of tests to write (#796) * Recommend using SI units in documentation (#795) * Create gallery example for datetime inputs (#779) -* Update GMT argument in the azimuthal (#776), conic (#780), cylindric (#789), and miscellaneous (#790) projections gallery to doc standards * Add an example for plotting multi-parameter symbols (#772) * Add a gallery example for the fig.image() method (#777) * Add a gallery example of setting line colors with a custom CPT (#774) * Add a table for compatibility of PyGMT with Python and GMT (#763) * Add description for the "columns" arguments (#766) * Add table for projections (#753) -* Add cylindric (#761), conic projection (#721, #757), miscellaneous projections descriptions (#723, #762), logarithmic and power projections (#742) to gallery +* Add more gallery examples for projections (#761, #721, #757, #723, #762, #742) * Add projection description for Lambert Azimuthal Equal-Area (#760) * Change text when GMTInvalidInput error is raised for basemap (#729) * Add non-geographic plots to projection gallery (#728) From 6d0208deed043a1f0bc3ac7a64f978631fbc2ab5 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Mon, 15 Feb 2021 16:45:04 +1300 Subject: [PATCH 08/18] Add highlights and list out contributor names ordered by no. of commits --- doc/changes.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index a0810272147..18b543beb19 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -10,11 +10,14 @@ Release v0.3.0 (2021/02/15) Highlights -* +* 🎉 **Third minor release of PyGMT** 🎉 +* Wrap inset (#788) for making overview maps and subplot (#822) for multi-panel figures +* Apply standardized formatting conventions (#775) across most documentation pages +* Drop Python 3.6 support (#699) so PyGMT now requires Python 3.7 or newer New Features -* Wrap grd2cpt (#803), inset (#788), and subplot (#822) +* Wrap grd2cpt (#803) * Let Figure.text() support record-by-record transparency (#716) * Provide basic support for FreeBSD (#700, #878) @@ -75,7 +78,6 @@ Maintenance * Improve the error message when PyGMT fails to load the GMT library (#814) * Add tests for GMTInvalidInput for figure.py (#810) * Split meca into a standalone module from base_plotting.py (#686) -* Update CONTRIBUTING.md with formatting conventions (#775) * Use args_in_kwargs for basemap error raising (#797) * Add docformatter to format plain text in docstrings (#642) * Add GMTInvalidInput Error for Figure.coast (#787) @@ -92,13 +94,14 @@ Maintenance * Switch from versioneer to setuptools-scm (#695) * Migrate coverage configurations to pyproject.toml (#667) -Deprecations - -* Drop Python 3.6 support (#699) - Contributors -@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer +* `Will Schlitzer `__ +* `Dongdong Tian `__ +* `Wei Ji Leong `__ +* `Michael Grund `__ +* `Liam Toney `__ +* `Meghan Jones `__ ---- From e944f1da2f45146e94d81a42ea9bd3f0cf1e7908 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sun, 14 Feb 2021 23:11:53 -0500 Subject: [PATCH 09/18] Group changes in the "Maintenance" section --- doc/changes.rst | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 18b543beb19..8cc1a795131 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -27,9 +27,11 @@ Enhancements * Improve how PyGMT finds the GMT library (#702) * Add dcw (#765) and lakes (#781) aliases to Figure.coast * Add the shading parameter to Figure.colorbar (#752) +* Improve the error message when PyGMT fails to load the GMT library (#814) +* Add GMTInvalidInput Error for Figure.coast (#787) Documentation - +* Add authorship policy (#726) * Update the docstrings in the plotting modules (#881) * Update the doc strings in the non-plotting modules (#882) * Add alias annotation (A) to Figure.contour() (#883) @@ -65,34 +67,29 @@ Bug Fixes * Fix a bug of Figure.text() when "text" is a non-string array (#724) * Fix the error message when IPython is not available (#701) -Maintenance - * Add dependabot to keep GitHub Actions up to date (#861) -* Add authorship policy (#726) -* Move plotting functions to separate modules (#808) * Skip workflows in PRs if only non-source-code files are changed (#839) -* Move non-plotting modules to separate files in src directory (#832) -* Show test execution times in pytest (#835) * Add slash command '/test-gmt-dev' to test GMT dev version (#831) -* Add tests for grdfilter (#809) -* Improve the error message when PyGMT fails to load the GMT library (#814) -* Add tests for GMTInvalidInput for figure.py (#810) -* Split meca into a standalone module from base_plotting.py (#686) -* Use args_in_kwargs for basemap error raising (#797) -* Add docformatter to format plain text in docstrings (#642) -* Add GMTInvalidInput Error for Figure.coast (#787) -* Add args_in_kwargs function (#791) -* Add a CI job testing GMT master branch on Windows (#756) -* Add isort to sort imports alphabetically (#745) -* Convert relative imports to absolute imports (#754) -* Add a Makefile target 'distclean' for deleting project metadata files (#744) -* Add test test_basemap_map_scale (#739) * Check files for UNIX-style line breaks and 644 permission (#736) * Rename vercel configuration file from now.json to vercel.json (#738) -* Migrate pytest configurations to pyproject.toml (#725) +* Add a CI job testing GMT master branch on Windows (#756) * Migrate documentation deployment from Travis CI to GitHub Actions (#713) +* Move Figure.meca() into a standalone module (#686) +* Move plotting functions to separate modules (#808) +* Move non-plotting modules to separate modules (#832) +* Add isort to sort imports alphabetically (#745) +* Convert relative imports to absolute imports (#754) * Switch from versioneer to setuptools-scm (#695) +* Add docformatter to format plain text in docstrings (#642) +* Migrate pytest configurations to pyproject.toml (#725) * Migrate coverage configurations to pyproject.toml (#667) +* Show test execution times in pytest (#835) +* Add tests for grdfilter (#809) +* Add tests for GMTInvalidInput of Figure.savefig() and Figure.show() (#810) +* Add args_in_kwargs function (#791) +* Add a Makefile target 'distclean' for deleting project metadata files (#744) +* Add a test Figure.basemap() map_scale (#739) +* Use args_in_kwargs for basemap error raising (#797) Contributors From 286fc4ba0405cb8d87c3cd4b2fe5461a07bf055f Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sun, 14 Feb 2021 23:13:15 -0500 Subject: [PATCH 10/18] Fix two issues in the previous commit --- doc/changes.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/changes.rst b/doc/changes.rst index 8cc1a795131..b38dac433c7 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -31,6 +31,7 @@ Enhancements * Add GMTInvalidInput Error for Figure.coast (#787) Documentation + * Add authorship policy (#726) * Update the docstrings in the plotting modules (#881) * Update the doc strings in the non-plotting modules (#882) @@ -67,6 +68,8 @@ Bug Fixes * Fix a bug of Figure.text() when "text" is a non-string array (#724) * Fix the error message when IPython is not available (#701) +Maintenance + * Add dependabot to keep GitHub Actions up to date (#861) * Skip workflows in PRs if only non-source-code files are changed (#839) * Add slash command '/test-gmt-dev' to test GMT dev version (#831) From 21593d9705e90f85ba38efabbdbad18719c772d9 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sun, 14 Feb 2021 23:28:55 -0500 Subject: [PATCH 11/18] Group changes in the 'Documentation' section and update some titles --- doc/changes.rst | 47 +++++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index b38dac433c7..e80cfc04bfe 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -25,43 +25,46 @@ Enhancements * Let load_earth_relief() support the 'region' parameter for all resolutions (#873) * Improve how PyGMT finds the GMT library (#702) -* Add dcw (#765) and lakes (#781) aliases to Figure.coast -* Add the shading parameter to Figure.colorbar (#752) +* Add common alias panel (-c) to all plotting functions (#853) +* Add aliases dcw (#765) and lakes (#781) to Figure.coast +* Add alias shading to Figure.colorbar (#752) +* Add alias annotation (A) to Figure.contour() (#883) +* Wrap Figure.grdinfo() aliases (#799) +* Add aliases frame and cmap to Figure.colorbar() (#709) +* Add alias frame to Figure.grdview() (#707) * Improve the error message when PyGMT fails to load the GMT library (#814) * Add GMTInvalidInput Error for Figure.coast (#787) Documentation * Add authorship policy (#726) +* Update PyGMT development installation instructions (#865) +* Add a tutorial for adding a map title (#720) +* Add a tutorial for plotting Earth relief (#712) +* Add a tutorial for 3D perspective image (#743) +* Add a tutorial for contour maps (#705) +* Add a tutorial for plotting lines +* Add a turorial for the region argument (#800) +* Add a gallery example for datetime inputs (#779) +* Add a gallery example for Figure.logo() (#823) +* Add a gallery example for plotting multi-parameter symbols (#772) +* Add a gallery example for Figure.image() (#777) +* Add a gallery example for setting line colors with a custom CPT (#774) +* Add more gallery examples for projections (#761, #721, #757, #723, #762, #742, #728, #727) * Update the docstrings in the plotting modules (#881) -* Update the doc strings in the non-plotting modules (#882) -* Add alias annotation (A) to Figure.contour() (#883) -* Revise pygmt development installation instructions (#865) +* Update the docstrings in the non-plotting modules (#882) +* Update Figure.coast() docstrings (#798) * Update the docstrings of common aliases (#862) -* Add common alias panel (-c) to all plotting functions (#853) -* Wrap grdinfo aliases (#799) * Add sphinx-copybutton extension to easily copy codes (#838) * Choosing the thumbnail figures in tutorials (#826) -* Add a gallery example for logo (#823) * Update axis label explanation in frames tutorial (#820) -* Update GMT arguments in coast doc strings (#798) * Add guidelines for types of tests to write (#796) * Recommend using SI units in documentation (#795) -* Create gallery example for datetime inputs (#779) -* Add an example for plotting multi-parameter symbols (#772) -* Add a gallery example for the fig.image() method (#777) -* Add a gallery example of setting line colors with a custom CPT (#774) * Add a table for compatibility of PyGMT with Python and GMT (#763) * Add description for the "columns" arguments (#766) -* Add table for projections (#753) -* Add more gallery examples for projections (#761, #721, #757, #723, #762, #742) +* Add a table for projections (#753) * Add projection description for Lambert Azimuthal Equal-Area (#760) * Change text when GMTInvalidInput error is raised for basemap (#729) -* Add non-geographic plots to projection gallery (#728) -* Adding cylindrical projections to gallery (#727) -* Add tutorials, for adding a map title (#720), plotting Earth relief (#712), 3D perspective image (#743), contour maps (#705), plotting lines tutorial (#741), region arguments (#800) -* Add frame and cmap to the colorbar parameters list (#709) -* Add frame as a parameter on the grdview documentation (#707) Bug Fixes @@ -91,8 +94,8 @@ Maintenance * Add tests for GMTInvalidInput of Figure.savefig() and Figure.show() (#810) * Add args_in_kwargs function (#791) * Add a Makefile target 'distclean' for deleting project metadata files (#744) -* Add a test Figure.basemap() map_scale (#739) -* Use args_in_kwargs for basemap error raising (#797) +* Add a test for Figure.basemap() map_scale (#739) +* Use args_in_kwargs for Figure.basemap() error raising (#797) Contributors From 32d6fc425b860f492814665a3c2db93a333481eb Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Mon, 15 Feb 2021 07:37:22 +0000 Subject: [PATCH 12/18] Apply suggestions from code review Co-authored-by: Dongdong Tian --- doc/changes.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index e80cfc04bfe..7f1e5be2ac2 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -28,12 +28,12 @@ Enhancements * Add common alias panel (-c) to all plotting functions (#853) * Add aliases dcw (#765) and lakes (#781) to Figure.coast * Add alias shading to Figure.colorbar (#752) -* Add alias annotation (A) to Figure.contour() (#883) +* Add alias annotation (A) to Figure.contour (#883) * Wrap Figure.grdinfo() aliases (#799) -* Add aliases frame and cmap to Figure.colorbar() (#709) -* Add alias frame to Figure.grdview() (#707) +* Add aliases frame and cmap to Figure.colorbar (#709) +* Add alias frame to Figure.grdview (#707) * Improve the error message when PyGMT fails to load the GMT library (#814) -* Add GMTInvalidInput Error for Figure.coast (#787) +* Add GMTInvalidInput error to Figure.coast (#787) Documentation @@ -56,7 +56,7 @@ Documentation * Update Figure.coast() docstrings (#798) * Update the docstrings of common aliases (#862) * Add sphinx-copybutton extension to easily copy codes (#838) -* Choosing the thumbnail figures in tutorials (#826) +* Choose the best figures in tutorials for thumbnails (#826) * Update axis label explanation in frames tutorial (#820) * Add guidelines for types of tests to write (#796) * Recommend using SI units in documentation (#795) From a02d9e389a416f638e9b5767099834f6ad47ca38 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Mon, 15 Feb 2021 07:57:56 +0000 Subject: [PATCH 13/18] Minor change log wording change --- doc/changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.rst b/doc/changes.rst index 7f1e5be2ac2..0846cf84c8c 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -62,7 +62,7 @@ Documentation * Recommend using SI units in documentation (#795) * Add a table for compatibility of PyGMT with Python and GMT (#763) * Add description for the "columns" arguments (#766) -* Add a table for projections (#753) +* Add a table of the available projections (#753) * Add projection description for Lambert Azimuthal Equal-Area (#760) * Change text when GMTInvalidInput error is raised for basemap (#729) From a98ca1e2ca38256027434766a64e18d143eb40d0 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Mon, 15 Feb 2021 08:27:07 +0000 Subject: [PATCH 14/18] Run sed command to format links --- doc/changes.rst | 134 ++++++++++++++++++++++++------------------------ 1 file changed, 67 insertions(+), 67 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 0846cf84c8c..f0a8f3356ad 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -11,91 +11,91 @@ Release v0.3.0 (2021/02/15) Highlights * 🎉 **Third minor release of PyGMT** 🎉 -* Wrap inset (#788) for making overview maps and subplot (#822) for multi-panel figures -* Apply standardized formatting conventions (#775) across most documentation pages -* Drop Python 3.6 support (#699) so PyGMT now requires Python 3.7 or newer +* Wrap inset (`#788 `__) for making overview maps and subplot (`#822 `__) for multi-panel figures +* Apply standardized formatting conventions (`#775 `__) across most documentation pages +* Drop Python 3.6 support (`#699 `__) so PyGMT now requires Python 3.7 or newer New Features -* Wrap grd2cpt (#803) -* Let Figure.text() support record-by-record transparency (#716) +* Wrap grd2cpt (`#803 `__) +* Let Figure.text() support record-by-record transparency (`#716 `__) * Provide basic support for FreeBSD (#700, #878) Enhancements -* Let load_earth_relief() support the 'region' parameter for all resolutions (#873) -* Improve how PyGMT finds the GMT library (#702) -* Add common alias panel (-c) to all plotting functions (#853) -* Add aliases dcw (#765) and lakes (#781) to Figure.coast -* Add alias shading to Figure.colorbar (#752) -* Add alias annotation (A) to Figure.contour (#883) -* Wrap Figure.grdinfo() aliases (#799) -* Add aliases frame and cmap to Figure.colorbar (#709) -* Add alias frame to Figure.grdview (#707) -* Improve the error message when PyGMT fails to load the GMT library (#814) -* Add GMTInvalidInput error to Figure.coast (#787) +* Let load_earth_relief() support the 'region' parameter for all resolutions (`#873 `__) +* Improve how PyGMT finds the GMT library (`#702 `__) +* Add common alias panel (-c) to all plotting functions (`#853 `__) +* Add aliases dcw (`#765 `__) and lakes (`#781 `__) to Figure.coast +* Add alias shading to Figure.colorbar (`#752 `__) +* Add alias annotation (A) to Figure.contour (`#883 `__) +* Wrap Figure.grdinfo() aliases (`#799 `__) +* Add aliases frame and cmap to Figure.colorbar (`#709 `__) +* Add alias frame to Figure.grdview (`#707 `__) +* Improve the error message when PyGMT fails to load the GMT library (`#814 `__) +* Add GMTInvalidInput error to Figure.coast (`#787 `__) Documentation -* Add authorship policy (#726) -* Update PyGMT development installation instructions (#865) -* Add a tutorial for adding a map title (#720) -* Add a tutorial for plotting Earth relief (#712) -* Add a tutorial for 3D perspective image (#743) -* Add a tutorial for contour maps (#705) +* Add authorship policy (`#726 `__) +* Update PyGMT development installation instructions (`#865 `__) +* Add a tutorial for adding a map title (`#720 `__) +* Add a tutorial for plotting Earth relief (`#712 `__) +* Add a tutorial for 3D perspective image (`#743 `__) +* Add a tutorial for contour maps (`#705 `__) * Add a tutorial for plotting lines -* Add a turorial for the region argument (#800) -* Add a gallery example for datetime inputs (#779) -* Add a gallery example for Figure.logo() (#823) -* Add a gallery example for plotting multi-parameter symbols (#772) -* Add a gallery example for Figure.image() (#777) -* Add a gallery example for setting line colors with a custom CPT (#774) +* Add a turorial for the region argument (`#800 `__) +* Add a gallery example for datetime inputs (`#779 `__) +* Add a gallery example for Figure.logo() (`#823 `__) +* Add a gallery example for plotting multi-parameter symbols (`#772 `__) +* Add a gallery example for Figure.image() (`#777 `__) +* Add a gallery example for setting line colors with a custom CPT (`#774 `__) * Add more gallery examples for projections (#761, #721, #757, #723, #762, #742, #728, #727) -* Update the docstrings in the plotting modules (#881) -* Update the docstrings in the non-plotting modules (#882) -* Update Figure.coast() docstrings (#798) -* Update the docstrings of common aliases (#862) -* Add sphinx-copybutton extension to easily copy codes (#838) -* Choose the best figures in tutorials for thumbnails (#826) -* Update axis label explanation in frames tutorial (#820) -* Add guidelines for types of tests to write (#796) -* Recommend using SI units in documentation (#795) -* Add a table for compatibility of PyGMT with Python and GMT (#763) -* Add description for the "columns" arguments (#766) -* Add a table of the available projections (#753) -* Add projection description for Lambert Azimuthal Equal-Area (#760) -* Change text when GMTInvalidInput error is raised for basemap (#729) +* Update the docstrings in the plotting modules (`#881 `__) +* Update the docstrings in the non-plotting modules (`#882 `__) +* Update Figure.coast() docstrings (`#798 `__) +* Update the docstrings of common aliases (`#862 `__) +* Add sphinx-copybutton extension to easily copy codes (`#838 `__) +* Choose the best figures in tutorials for thumbnails (`#826 `__) +* Update axis label explanation in frames tutorial (`#820 `__) +* Add guidelines for types of tests to write (`#796 `__) +* Recommend using SI units in documentation (`#795 `__) +* Add a table for compatibility of PyGMT with Python and GMT (`#763 `__) +* Add description for the "columns" arguments (`#766 `__) +* Add a table of the available projections (`#753 `__) +* Add projection description for Lambert Azimuthal Equal-Area (`#760 `__) +* Change text when GMTInvalidInput error is raised for basemap (`#729 `__) Bug Fixes -* Fix a bug of Figure.text() when "text" is a non-string array (#724) -* Fix the error message when IPython is not available (#701) +* Fix a bug of Figure.text() when "text" is a non-string array (`#724 `__) +* Fix the error message when IPython is not available (`#701 `__) Maintenance -* Add dependabot to keep GitHub Actions up to date (#861) -* Skip workflows in PRs if only non-source-code files are changed (#839) -* Add slash command '/test-gmt-dev' to test GMT dev version (#831) -* Check files for UNIX-style line breaks and 644 permission (#736) -* Rename vercel configuration file from now.json to vercel.json (#738) -* Add a CI job testing GMT master branch on Windows (#756) -* Migrate documentation deployment from Travis CI to GitHub Actions (#713) -* Move Figure.meca() into a standalone module (#686) -* Move plotting functions to separate modules (#808) -* Move non-plotting modules to separate modules (#832) -* Add isort to sort imports alphabetically (#745) -* Convert relative imports to absolute imports (#754) -* Switch from versioneer to setuptools-scm (#695) -* Add docformatter to format plain text in docstrings (#642) -* Migrate pytest configurations to pyproject.toml (#725) -* Migrate coverage configurations to pyproject.toml (#667) -* Show test execution times in pytest (#835) -* Add tests for grdfilter (#809) -* Add tests for GMTInvalidInput of Figure.savefig() and Figure.show() (#810) -* Add args_in_kwargs function (#791) -* Add a Makefile target 'distclean' for deleting project metadata files (#744) -* Add a test for Figure.basemap() map_scale (#739) -* Use args_in_kwargs for Figure.basemap() error raising (#797) +* Add dependabot to keep GitHub Actions up to date (`#861 `__) +* Skip workflows in PRs if only non-source-code files are changed (`#839 `__) +* Add slash command '/test-gmt-dev' to test GMT dev version (`#831 `__) +* Check files for UNIX-style line breaks and 644 permission (`#736 `__) +* Rename vercel configuration file from now.json to vercel.json (`#738 `__) +* Add a CI job testing GMT master branch on Windows (`#756 `__) +* Migrate documentation deployment from Travis CI to GitHub Actions (`#713 `__) +* Move Figure.meca() into a standalone module (`#686 `__) +* Move plotting functions to separate modules (`#808 `__) +* Move non-plotting modules to separate modules (`#832 `__) +* Add isort to sort imports alphabetically (`#745 `__) +* Convert relative imports to absolute imports (`#754 `__) +* Switch from versioneer to setuptools-scm (`#695 `__) +* Add docformatter to format plain text in docstrings (`#642 `__) +* Migrate pytest configurations to pyproject.toml (`#725 `__) +* Migrate coverage configurations to pyproject.toml (`#667 `__) +* Show test execution times in pytest (`#835 `__) +* Add tests for grdfilter (`#809 `__) +* Add tests for GMTInvalidInput of Figure.savefig() and Figure.show() (`#810 `__) +* Add args_in_kwargs function (`#791 `__) +* Add a Makefile target 'distclean' for deleting project metadata files (`#744 `__) +* Add a test for Figure.basemap() map_scale (`#739 `__) +* Use args_in_kwargs for Figure.basemap() error raising (`#797 `__) Contributors From 98097bc6052180e723454deec23f0fb7a2389c4b Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Mon, 15 Feb 2021 08:52:29 +0000 Subject: [PATCH 15/18] Run sed command to format links; format fixes --- doc/changes.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index f0a8f3356ad..bd64bee78d7 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -18,18 +18,18 @@ Highlights New Features * Wrap grd2cpt (`#803 `__) -* Let Figure.text() support record-by-record transparency (`#716 `__) -* Provide basic support for FreeBSD (#700, #878) +* Let Figure.text support record-by-record transparency (`#716 `__) +* Provide basic support for FreeBSD (`#700 `__) (`#878 `__) Enhancements -* Let load_earth_relief() support the 'region' parameter for all resolutions (`#873 `__) +* Let load_earth_relief support the 'region' parameter for all resolutions (`#873 `__) * Improve how PyGMT finds the GMT library (`#702 `__) * Add common alias panel (-c) to all plotting functions (`#853 `__) * Add aliases dcw (`#765 `__) and lakes (`#781 `__) to Figure.coast * Add alias shading to Figure.colorbar (`#752 `__) * Add alias annotation (A) to Figure.contour (`#883 `__) -* Wrap Figure.grdinfo() aliases (`#799 `__) +* Wrap Figure.grdinfo aliases (`#799 `__) * Add aliases frame and cmap to Figure.colorbar (`#709 `__) * Add alias frame to Figure.grdview (`#707 `__) * Improve the error message when PyGMT fails to load the GMT library (`#814 `__) @@ -43,17 +43,17 @@ Documentation * Add a tutorial for plotting Earth relief (`#712 `__) * Add a tutorial for 3D perspective image (`#743 `__) * Add a tutorial for contour maps (`#705 `__) -* Add a tutorial for plotting lines +* Add a tutorial for plotting lines (`#741 `__) * Add a turorial for the region argument (`#800 `__) * Add a gallery example for datetime inputs (`#779 `__) -* Add a gallery example for Figure.logo() (`#823 `__) +* Add a gallery example for Figure.logo (`#823 `__) * Add a gallery example for plotting multi-parameter symbols (`#772 `__) -* Add a gallery example for Figure.image() (`#777 `__) +* Add a gallery example for Figure.image (`#777 `__) * Add a gallery example for setting line colors with a custom CPT (`#774 `__) -* Add more gallery examples for projections (#761, #721, #757, #723, #762, #742, #728, #727) +* Add more gallery examples for projections (`#761 `__) (`#721 `__) (`#757 `__) (`#723 `__) (`#762 `__) (`#742 `__) (`#728 `__) (`#727 `__) * Update the docstrings in the plotting modules (`#881 `__) * Update the docstrings in the non-plotting modules (`#882 `__) -* Update Figure.coast() docstrings (`#798 `__) +* Update Figure.coast docstrings (`#798 `__) * Update the docstrings of common aliases (`#862 `__) * Add sphinx-copybutton extension to easily copy codes (`#838 `__) * Choose the best figures in tutorials for thumbnails (`#826 `__) @@ -68,7 +68,7 @@ Documentation Bug Fixes -* Fix a bug of Figure.text() when "text" is a non-string array (`#724 `__) +* Fix a bug of Figure.text when "text" is a non-string array (`#724 `__) * Fix the error message when IPython is not available (`#701 `__) Maintenance @@ -80,7 +80,7 @@ Maintenance * Rename vercel configuration file from now.json to vercel.json (`#738 `__) * Add a CI job testing GMT master branch on Windows (`#756 `__) * Migrate documentation deployment from Travis CI to GitHub Actions (`#713 `__) -* Move Figure.meca() into a standalone module (`#686 `__) +* Move Figure.meca into a standalone module (`#686 `__) * Move plotting functions to separate modules (`#808 `__) * Move non-plotting modules to separate modules (`#832 `__) * Add isort to sort imports alphabetically (`#745 `__) @@ -94,8 +94,8 @@ Maintenance * Add tests for GMTInvalidInput of Figure.savefig() and Figure.show() (`#810 `__) * Add args_in_kwargs function (`#791 `__) * Add a Makefile target 'distclean' for deleting project metadata files (`#744 `__) -* Add a test for Figure.basemap() map_scale (`#739 `__) -* Use args_in_kwargs for Figure.basemap() error raising (`#797 `__) +* Add a test for Figure.basemap map_scale (`#739 `__) +* Use args_in_kwargs for Figure.basemap error raising (`#797 `__) Contributors From 23bf843791704494f9ddcb09cf816a4fd5490517 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Mon, 15 Feb 2021 09:00:06 +0000 Subject: [PATCH 16/18] format fixes --- doc/changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.rst b/doc/changes.rst index bd64bee78d7..4a5d9194cc9 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -91,7 +91,7 @@ Maintenance * Migrate coverage configurations to pyproject.toml (`#667 `__) * Show test execution times in pytest (`#835 `__) * Add tests for grdfilter (`#809 `__) -* Add tests for GMTInvalidInput of Figure.savefig() and Figure.show() (`#810 `__) +* Add tests for GMTInvalidInput of Figure.savefig and Figure.show (`#810 `__) * Add args_in_kwargs function (`#791 `__) * Add a Makefile target 'distclean' for deleting project metadata files (`#744 `__) * Add a test for Figure.basemap map_scale (`#739 `__) From dae98047ec8ae80f3e2d4309d92d802ab30b488a Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Mon, 15 Feb 2021 09:06:42 +0000 Subject: [PATCH 17/18] Apply suggestions from code review Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> --- doc/changes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 4a5d9194cc9..dd7b07e7fc0 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -19,7 +19,7 @@ New Features * Wrap grd2cpt (`#803 `__) * Let Figure.text support record-by-record transparency (`#716 `__) -* Provide basic support for FreeBSD (`#700 `__) (`#878 `__) +* Provide basic support for FreeBSD (`#700 `__, `#878 `__) Enhancements @@ -50,7 +50,7 @@ Documentation * Add a gallery example for plotting multi-parameter symbols (`#772 `__) * Add a gallery example for Figure.image (`#777 `__) * Add a gallery example for setting line colors with a custom CPT (`#774 `__) -* Add more gallery examples for projections (`#761 `__) (`#721 `__) (`#757 `__) (`#723 `__) (`#762 `__) (`#742 `__) (`#728 `__) (`#727 `__) +* Add more gallery examples for projections (`#761 `__, `#721 `__, `#757 `__, `#723 `__, `#762 `__, `#742 `__, `#728 `__, `#727 `__) * Update the docstrings in the plotting modules (`#881 `__) * Update the docstrings in the non-plotting modules (`#882 `__) * Update Figure.coast docstrings (`#798 `__) From 8a20f3ae66eaa16078b6e5fa7b4b06db1e5f5f6c Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Mon, 15 Feb 2021 22:14:35 +1300 Subject: [PATCH 18/18] Fix a typo --- doc/changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.rst b/doc/changes.rst index dd7b07e7fc0..a35d471ac2d 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -44,7 +44,7 @@ Documentation * Add a tutorial for 3D perspective image (`#743 `__) * Add a tutorial for contour maps (`#705 `__) * Add a tutorial for plotting lines (`#741 `__) -* Add a turorial for the region argument (`#800 `__) +* Add a tutorial for the region argument (`#800 `__) * Add a gallery example for datetime inputs (`#779 `__) * Add a gallery example for Figure.logo (`#823 `__) * Add a gallery example for plotting multi-parameter symbols (`#772 `__)