From faf49e376a32b5ea1e0665f9f665dc23aac474af Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 23 Oct 2021 11:03:24 -0400 Subject: [PATCH 1/9] Restructure the tutorial section of the documentation sidebar --- doc/conf.py | 3 +++ doc/index.rst | 27 +++---------------- examples/tutorials/README.txt | 2 ++ examples/tutorials/advanced/README.txt | 2 ++ .../{ => advanced}/date_time_charts.py | 2 +- examples/tutorials/{ => advanced}/vectors.py | 0 examples/tutorials/beginner/README.txt | 2 ++ .../tutorials/{ => beginner}/coastlines.py | 0 .../tutorials/{ => beginner}/first_figure.py | 0 examples/tutorials/{ => beginner}/frames.py | 0 examples/tutorials/{ => beginner}/lines.py | 0 examples/tutorials/{ => beginner}/plot.py | 0 examples/tutorials/{ => beginner}/regions.py | 0 examples/tutorials/{ => beginner}/text.py | 0 .../3d_perspective_image.py | 0 examples/tutorials/intermediate/README.txt | 2 ++ .../{ => intermediate}/configuration.py | 0 .../{ => intermediate}/contour_map.py | 0 .../{ => intermediate}/earth_relief.py | 0 .../tutorials/{ => intermediate}/insets.py | 0 .../tutorials/{ => intermediate}/subplots.py | 0 pygmt/helpers/decorators.py | 4 +-- pygmt/src/grdview.py | 8 +++--- 23 files changed, 22 insertions(+), 30 deletions(-) create mode 100644 examples/tutorials/advanced/README.txt rename examples/tutorials/{ => advanced}/date_time_charts.py (99%) rename examples/tutorials/{ => advanced}/vectors.py (100%) create mode 100644 examples/tutorials/beginner/README.txt rename examples/tutorials/{ => beginner}/coastlines.py (100%) rename examples/tutorials/{ => beginner}/first_figure.py (100%) rename examples/tutorials/{ => beginner}/frames.py (100%) rename examples/tutorials/{ => beginner}/lines.py (100%) rename examples/tutorials/{ => beginner}/plot.py (100%) rename examples/tutorials/{ => beginner}/regions.py (100%) rename examples/tutorials/{ => beginner}/text.py (100%) rename examples/tutorials/{ => intermediate}/3d_perspective_image.py (100%) create mode 100644 examples/tutorials/intermediate/README.txt rename examples/tutorials/{ => intermediate}/configuration.py (100%) rename examples/tutorials/{ => intermediate}/contour_map.py (100%) rename examples/tutorials/{ => intermediate}/earth_relief.py (100%) rename examples/tutorials/{ => intermediate}/insets.py (100%) rename examples/tutorials/{ => intermediate}/subplots.py (100%) diff --git a/doc/conf.py b/doc/conf.py index 39ba1db6cda..36e1fa6e030 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -87,6 +87,9 @@ "../examples/projections/misc", "../examples/projections/nongeo", "../examples/projections/table", + "../examples/tutorials/beginner", + "../examples/tutorials/intermediate", + "../examples/tutorials/advanced", ] ), # Patter to search for example files diff --git a/doc/index.rst b/doc/index.rst index 88ffce2a705..f453008b5fa 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -20,36 +20,17 @@ overview.rst install.rst - tutorials/first_figure.rst - -.. toctree:: - :maxdepth: 2 - :hidden: - :caption: Examples - - gallery/index.rst - external_resources.md + tutorials/beginner/first_figure.rst .. toctree:: :maxdepth: 2 :hidden: :caption: User Guide - tutorials/frames.rst + gallery/index.rst projections/index.rst - tutorials/coastlines.rst - tutorials/regions.rst - tutorials/plot.rst - tutorials/lines.rst - tutorials/vectors.rst - tutorials/date_time_charts.rst - tutorials/text.rst - tutorials/contour_map.rst - tutorials/earth_relief.rst - tutorials/3d_perspective_image.rst - tutorials/insets.rst - tutorials/subplots.rst - tutorials/configuration.rst + tutorials/index.rst + external_resources.md .. toctree:: :maxdepth: 2 diff --git a/examples/tutorials/README.txt b/examples/tutorials/README.txt index 0c7e28c3b35..05bfc5a5ded 100644 --- a/examples/tutorials/README.txt +++ b/examples/tutorials/README.txt @@ -1,2 +1,4 @@ Tutorials ========= + +These tutorials teach how to complete various tasks using PyGMT. diff --git a/examples/tutorials/advanced/README.txt b/examples/tutorials/advanced/README.txt new file mode 100644 index 00000000000..c13be26cec3 --- /dev/null +++ b/examples/tutorials/advanced/README.txt @@ -0,0 +1,2 @@ +Advanced Tutorials +================== diff --git a/examples/tutorials/date_time_charts.py b/examples/tutorials/advanced/date_time_charts.py similarity index 99% rename from examples/tutorials/date_time_charts.py rename to examples/tutorials/advanced/date_time_charts.py index 31e40c32585..f7fea4820e4 100644 --- a/examples/tutorials/date_time_charts.py +++ b/examples/tutorials/advanced/date_time_charts.py @@ -285,7 +285,7 @@ # Starting off with ``WS``, adding this string means that only # Western/Left (**W**) and Southern/Bottom (**S**) borders of # the plot will be shown. For more information on this, please -# refer to :doc:`frame instructions `. +# refer to :doc:`frame instructions `. # # The other important item in the ``frame`` list is # ``"sxa1Of1D"``. This string modifies the secondary diff --git a/examples/tutorials/vectors.py b/examples/tutorials/advanced/vectors.py similarity index 100% rename from examples/tutorials/vectors.py rename to examples/tutorials/advanced/vectors.py diff --git a/examples/tutorials/beginner/README.txt b/examples/tutorials/beginner/README.txt new file mode 100644 index 00000000000..f798beed635 --- /dev/null +++ b/examples/tutorials/beginner/README.txt @@ -0,0 +1,2 @@ +Beginner Tutorials +================== diff --git a/examples/tutorials/coastlines.py b/examples/tutorials/beginner/coastlines.py similarity index 100% rename from examples/tutorials/coastlines.py rename to examples/tutorials/beginner/coastlines.py diff --git a/examples/tutorials/first_figure.py b/examples/tutorials/beginner/first_figure.py similarity index 100% rename from examples/tutorials/first_figure.py rename to examples/tutorials/beginner/first_figure.py diff --git a/examples/tutorials/frames.py b/examples/tutorials/beginner/frames.py similarity index 100% rename from examples/tutorials/frames.py rename to examples/tutorials/beginner/frames.py diff --git a/examples/tutorials/lines.py b/examples/tutorials/beginner/lines.py similarity index 100% rename from examples/tutorials/lines.py rename to examples/tutorials/beginner/lines.py diff --git a/examples/tutorials/plot.py b/examples/tutorials/beginner/plot.py similarity index 100% rename from examples/tutorials/plot.py rename to examples/tutorials/beginner/plot.py diff --git a/examples/tutorials/regions.py b/examples/tutorials/beginner/regions.py similarity index 100% rename from examples/tutorials/regions.py rename to examples/tutorials/beginner/regions.py diff --git a/examples/tutorials/text.py b/examples/tutorials/beginner/text.py similarity index 100% rename from examples/tutorials/text.py rename to examples/tutorials/beginner/text.py diff --git a/examples/tutorials/3d_perspective_image.py b/examples/tutorials/intermediate/3d_perspective_image.py similarity index 100% rename from examples/tutorials/3d_perspective_image.py rename to examples/tutorials/intermediate/3d_perspective_image.py diff --git a/examples/tutorials/intermediate/README.txt b/examples/tutorials/intermediate/README.txt new file mode 100644 index 00000000000..6afe2ee7509 --- /dev/null +++ b/examples/tutorials/intermediate/README.txt @@ -0,0 +1,2 @@ +Intermediate Tutorials +====================== diff --git a/examples/tutorials/configuration.py b/examples/tutorials/intermediate/configuration.py similarity index 100% rename from examples/tutorials/configuration.py rename to examples/tutorials/intermediate/configuration.py diff --git a/examples/tutorials/contour_map.py b/examples/tutorials/intermediate/contour_map.py similarity index 100% rename from examples/tutorials/contour_map.py rename to examples/tutorials/intermediate/contour_map.py diff --git a/examples/tutorials/earth_relief.py b/examples/tutorials/intermediate/earth_relief.py similarity index 100% rename from examples/tutorials/earth_relief.py rename to examples/tutorials/intermediate/earth_relief.py diff --git a/examples/tutorials/insets.py b/examples/tutorials/intermediate/insets.py similarity index 100% rename from examples/tutorials/insets.py rename to examples/tutorials/intermediate/insets.py diff --git a/examples/tutorials/subplots.py b/examples/tutorials/intermediate/subplots.py similarity index 100% rename from examples/tutorials/subplots.py rename to examples/tutorials/intermediate/subplots.py diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index f389086c988..bbff9c0aab3 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -18,7 +18,7 @@ "R": r""" region : str or list *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*]. - Specify the :doc:`region ` of interest.""", + Specify the :doc:`region ` of interest.""", "J": r""" projection : str *projcode*\[*projparams*/]\ *width*. @@ -34,7 +34,7 @@ "B": r""" frame : bool or str or list Set map boundary - :doc:`frame and axes attributes `. """, + :doc:`frame and axes attributes `. """, "U": """\ timestamp : bool or str Draw GMT time stamp logo on plot.""", diff --git a/pygmt/src/grdview.py b/pygmt/src/grdview.py index a4e7646f60f..5a6c93be5ad 100644 --- a/pygmt/src/grdview.py +++ b/pygmt/src/grdview.py @@ -61,10 +61,10 @@ def grdview(self, grid, **kwargs): DataArray. region : str or list *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*]. - Specify the :doc:`region ` of interest. When used - with ``perspective``, optionally append */zmin/zmax* to indicate the - range to use for the 3-D axes [Default is the region in the input - grid]. + Specify the :doc:`region ` of interest. + When used with ``perspective``, optionally append */zmin/zmax* to + indicate the range to use for the 3-D axes [Default is the region in + the input grid]. {J} zscale/zsize : float or str Set z-axis scaling or z-axis size. From 124d1337ed6fbd5a05c4c08227e3d6991b126bd6 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 1 Nov 2021 17:51:05 -0400 Subject: [PATCH 2/9] Update header levels --- examples/tutorials/README.txt | 2 ++ examples/tutorials/advanced/README.txt | 2 +- examples/tutorials/beginner/README.txt | 2 +- examples/tutorials/intermediate/README.txt | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/examples/tutorials/README.txt b/examples/tutorials/README.txt index 05bfc5a5ded..dee14126d0c 100644 --- a/examples/tutorials/README.txt +++ b/examples/tutorials/README.txt @@ -1,3 +1,5 @@ +.. _tutorials: + Tutorials ========= diff --git a/examples/tutorials/advanced/README.txt b/examples/tutorials/advanced/README.txt index c13be26cec3..1bb75e1d22a 100644 --- a/examples/tutorials/advanced/README.txt +++ b/examples/tutorials/advanced/README.txt @@ -1,2 +1,2 @@ Advanced Tutorials -================== +------------------ diff --git a/examples/tutorials/beginner/README.txt b/examples/tutorials/beginner/README.txt index f798beed635..6a5631a9b90 100644 --- a/examples/tutorials/beginner/README.txt +++ b/examples/tutorials/beginner/README.txt @@ -1,2 +1,2 @@ Beginner Tutorials -================== +------------------ diff --git a/examples/tutorials/intermediate/README.txt b/examples/tutorials/intermediate/README.txt index 6afe2ee7509..f2028a86b13 100644 --- a/examples/tutorials/intermediate/README.txt +++ b/examples/tutorials/intermediate/README.txt @@ -1,2 +1,2 @@ Intermediate Tutorials -====================== +---------------------- From 8a30bf298e1187324c79c7a8ec759e50bb58b153 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Thu, 4 Nov 2021 14:00:30 -0400 Subject: [PATCH 3/9] Consolidate intermediate and advanced tutorials --- doc/conf.py | 1 - .../{intermediate => advanced}/3d_perspective_image.py | 0 examples/tutorials/{intermediate => advanced}/configuration.py | 0 examples/tutorials/{intermediate => advanced}/contour_map.py | 0 examples/tutorials/{intermediate => advanced}/earth_relief.py | 0 examples/tutorials/{intermediate => advanced}/insets.py | 0 examples/tutorials/{intermediate => advanced}/subplots.py | 0 examples/tutorials/intermediate/README.txt | 2 -- 8 files changed, 3 deletions(-) rename examples/tutorials/{intermediate => advanced}/3d_perspective_image.py (100%) rename examples/tutorials/{intermediate => advanced}/configuration.py (100%) rename examples/tutorials/{intermediate => advanced}/contour_map.py (100%) rename examples/tutorials/{intermediate => advanced}/earth_relief.py (100%) rename examples/tutorials/{intermediate => advanced}/insets.py (100%) rename examples/tutorials/{intermediate => advanced}/subplots.py (100%) delete mode 100644 examples/tutorials/intermediate/README.txt diff --git a/doc/conf.py b/doc/conf.py index 36e1fa6e030..4bd8767acbe 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -88,7 +88,6 @@ "../examples/projections/nongeo", "../examples/projections/table", "../examples/tutorials/beginner", - "../examples/tutorials/intermediate", "../examples/tutorials/advanced", ] ), diff --git a/examples/tutorials/intermediate/3d_perspective_image.py b/examples/tutorials/advanced/3d_perspective_image.py similarity index 100% rename from examples/tutorials/intermediate/3d_perspective_image.py rename to examples/tutorials/advanced/3d_perspective_image.py diff --git a/examples/tutorials/intermediate/configuration.py b/examples/tutorials/advanced/configuration.py similarity index 100% rename from examples/tutorials/intermediate/configuration.py rename to examples/tutorials/advanced/configuration.py diff --git a/examples/tutorials/intermediate/contour_map.py b/examples/tutorials/advanced/contour_map.py similarity index 100% rename from examples/tutorials/intermediate/contour_map.py rename to examples/tutorials/advanced/contour_map.py diff --git a/examples/tutorials/intermediate/earth_relief.py b/examples/tutorials/advanced/earth_relief.py similarity index 100% rename from examples/tutorials/intermediate/earth_relief.py rename to examples/tutorials/advanced/earth_relief.py diff --git a/examples/tutorials/intermediate/insets.py b/examples/tutorials/advanced/insets.py similarity index 100% rename from examples/tutorials/intermediate/insets.py rename to examples/tutorials/advanced/insets.py diff --git a/examples/tutorials/intermediate/subplots.py b/examples/tutorials/advanced/subplots.py similarity index 100% rename from examples/tutorials/intermediate/subplots.py rename to examples/tutorials/advanced/subplots.py diff --git a/examples/tutorials/intermediate/README.txt b/examples/tutorials/intermediate/README.txt deleted file mode 100644 index f2028a86b13..00000000000 --- a/examples/tutorials/intermediate/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Intermediate Tutorials ----------------------- From b5e1ac3906fbda791f347894c29c8ee6bee7f608 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Thu, 4 Nov 2021 15:02:53 -0400 Subject: [PATCH 4/9] Update contributing guide --- doc/contributing.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/doc/contributing.md b/doc/contributing.md index 636f5841086..d37ecb426fc 100644 --- a/doc/contributing.md +++ b/doc/contributing.md @@ -322,12 +322,9 @@ General guidelines for making a good gallery plot: The tutorials (the User Guide in the docs) are also built by sphinx-gallery from the `.py` files in the `examples/tutorials` folder of the repository. To add a new tutorial: -* Include a `.py` file in the `examples/tutorials` folder on the base of the repository. +* Create a `.py` file in the `examples/tutorials/advanced` folder. * Write the tutorial in "notebook" style with code mixed with paragraphs explaining what is being done. See the other tutorials for the format. -* Include the tutorial in the table of contents of the documentation (side bar). Do this - by adding a line to the User Guide `toc` directive in `doc/index.rst`. Notice that the - file included is the `.rst` generated by sphinx-gallery. * Choose the most representative figure as the thumbnail figure by adding a comment line `# sphinx_gallery_thumbnail_number = ` to any place (usually at the top) in the tutorial. The *fig_number* starts from 1. From db649835be5c2c8a09cc08b3f84ad70eb078b7b2 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Thu, 4 Nov 2021 15:31:56 -0400 Subject: [PATCH 5/9] Fix path in fmt_docstring() --- pygmt/helpers/decorators.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index f9daf38ae76..25526b4d50e 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -447,7 +447,7 @@ def fmt_docstring(module_func): tabular data. region : str or list *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*]. - Specify the :doc:`region ` of interest. + Specify the :doc:`region ` of interest. projection : str *projcode*\[*projparams*/]\ *width*. Select map :doc:`projection `. From c6649a0cd96b2957296f2d02db78607ad9874d36 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Fri, 5 Nov 2021 12:34:36 -0400 Subject: [PATCH 6/9] List tutorials prior to gallery in the toctree --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index f453008b5fa..62fd93c2037 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -27,9 +27,9 @@ :hidden: :caption: User Guide + tutorials/index.rst gallery/index.rst projections/index.rst - tutorials/index.rst external_resources.md .. toctree:: From 3c8fc75ed47815c81d919d05f897d3c2f8629d37 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 8 Nov 2021 13:17:39 -0500 Subject: [PATCH 7/9] Apply suggestions from code review Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> --- examples/tutorials/README.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/tutorials/README.txt b/examples/tutorials/README.txt index dee14126d0c..4ae40011e79 100644 --- a/examples/tutorials/README.txt +++ b/examples/tutorials/README.txt @@ -3,4 +3,4 @@ Tutorials ========= -These tutorials teach how to complete various tasks using PyGMT. +These examples teach us how to complete various tasks using PyGMT! From 0360ffec6dbb2d47d8aab4effdb3a4ea293bdc80 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 8 Nov 2021 13:35:14 -0500 Subject: [PATCH 8/9] Fix sphinx_gallery_thumbnail_number --- examples/tutorials/advanced/date_time_charts.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/tutorials/advanced/date_time_charts.py b/examples/tutorials/advanced/date_time_charts.py index f7fea4820e4..e712ed12874 100644 --- a/examples/tutorials/advanced/date_time_charts.py +++ b/examples/tutorials/advanced/date_time_charts.py @@ -11,7 +11,7 @@ The following examples will demonstrate how to create plots using the different datetime objects. """ -# sphinx_gallery_thumbnail_number = 0 +# sphinx_gallery_thumbnail_number = 8 import datetime From a5a146293d6fafc0245d8763bc8ec17d5a366c15 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 8 Nov 2021 13:49:26 -0500 Subject: [PATCH 9/9] Change beginner to basics --- doc/conf.py | 2 +- doc/index.rst | 2 +- examples/tutorials/advanced/README.txt | 4 ++-- examples/tutorials/advanced/date_time_charts.py | 2 +- examples/tutorials/basics/README.txt | 2 ++ examples/tutorials/{beginner => basics}/coastlines.py | 0 examples/tutorials/{beginner => basics}/first_figure.py | 0 examples/tutorials/{beginner => basics}/frames.py | 0 examples/tutorials/{beginner => basics}/lines.py | 0 examples/tutorials/{beginner => basics}/plot.py | 0 examples/tutorials/{beginner => basics}/regions.py | 0 examples/tutorials/{beginner => basics}/text.py | 0 examples/tutorials/beginner/README.txt | 2 -- pygmt/helpers/decorators.py | 6 +++--- pygmt/src/grdview.py | 2 +- 15 files changed, 11 insertions(+), 11 deletions(-) create mode 100644 examples/tutorials/basics/README.txt rename examples/tutorials/{beginner => basics}/coastlines.py (100%) rename examples/tutorials/{beginner => basics}/first_figure.py (100%) rename examples/tutorials/{beginner => basics}/frames.py (100%) rename examples/tutorials/{beginner => basics}/lines.py (100%) rename examples/tutorials/{beginner => basics}/plot.py (100%) rename examples/tutorials/{beginner => basics}/regions.py (100%) rename examples/tutorials/{beginner => basics}/text.py (100%) delete mode 100644 examples/tutorials/beginner/README.txt diff --git a/doc/conf.py b/doc/conf.py index 4bd8767acbe..1ce78b421f0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -87,7 +87,7 @@ "../examples/projections/misc", "../examples/projections/nongeo", "../examples/projections/table", - "../examples/tutorials/beginner", + "../examples/tutorials/basics", "../examples/tutorials/advanced", ] ), diff --git a/doc/index.rst b/doc/index.rst index 62fd93c2037..6d34e27b28c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -20,7 +20,7 @@ overview.rst install.rst - tutorials/beginner/first_figure.rst + tutorials/basics/first_figure.rst .. toctree:: :maxdepth: 2 diff --git a/examples/tutorials/advanced/README.txt b/examples/tutorials/advanced/README.txt index 1bb75e1d22a..4519ce7c669 100644 --- a/examples/tutorials/advanced/README.txt +++ b/examples/tutorials/advanced/README.txt @@ -1,2 +1,2 @@ -Advanced Tutorials ------------------- +Advanced +-------- diff --git a/examples/tutorials/advanced/date_time_charts.py b/examples/tutorials/advanced/date_time_charts.py index e712ed12874..fbb26e90442 100644 --- a/examples/tutorials/advanced/date_time_charts.py +++ b/examples/tutorials/advanced/date_time_charts.py @@ -285,7 +285,7 @@ # Starting off with ``WS``, adding this string means that only # Western/Left (**W**) and Southern/Bottom (**S**) borders of # the plot will be shown. For more information on this, please -# refer to :doc:`frame instructions `. +# refer to :doc:`frame instructions `. # # The other important item in the ``frame`` list is # ``"sxa1Of1D"``. This string modifies the secondary diff --git a/examples/tutorials/basics/README.txt b/examples/tutorials/basics/README.txt new file mode 100644 index 00000000000..b76022bb84e --- /dev/null +++ b/examples/tutorials/basics/README.txt @@ -0,0 +1,2 @@ +Basics +------ diff --git a/examples/tutorials/beginner/coastlines.py b/examples/tutorials/basics/coastlines.py similarity index 100% rename from examples/tutorials/beginner/coastlines.py rename to examples/tutorials/basics/coastlines.py diff --git a/examples/tutorials/beginner/first_figure.py b/examples/tutorials/basics/first_figure.py similarity index 100% rename from examples/tutorials/beginner/first_figure.py rename to examples/tutorials/basics/first_figure.py diff --git a/examples/tutorials/beginner/frames.py b/examples/tutorials/basics/frames.py similarity index 100% rename from examples/tutorials/beginner/frames.py rename to examples/tutorials/basics/frames.py diff --git a/examples/tutorials/beginner/lines.py b/examples/tutorials/basics/lines.py similarity index 100% rename from examples/tutorials/beginner/lines.py rename to examples/tutorials/basics/lines.py diff --git a/examples/tutorials/beginner/plot.py b/examples/tutorials/basics/plot.py similarity index 100% rename from examples/tutorials/beginner/plot.py rename to examples/tutorials/basics/plot.py diff --git a/examples/tutorials/beginner/regions.py b/examples/tutorials/basics/regions.py similarity index 100% rename from examples/tutorials/beginner/regions.py rename to examples/tutorials/basics/regions.py diff --git a/examples/tutorials/beginner/text.py b/examples/tutorials/basics/text.py similarity index 100% rename from examples/tutorials/beginner/text.py rename to examples/tutorials/basics/text.py diff --git a/examples/tutorials/beginner/README.txt b/examples/tutorials/beginner/README.txt deleted file mode 100644 index 6a5631a9b90..00000000000 --- a/examples/tutorials/beginner/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Beginner Tutorials ------------------- diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index 25526b4d50e..f90e55f2eba 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -18,7 +18,7 @@ "R": r""" region : str or list *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*]. - Specify the :doc:`region ` of interest.""", + Specify the :doc:`region ` of interest.""", "J": r""" projection : str *projcode*\[*projparams*/]\ *width*. @@ -34,7 +34,7 @@ "B": r""" frame : bool or str or list Set map boundary - :doc:`frame and axes attributes `. """, + :doc:`frame and axes attributes `. """, "U": """\ timestamp : bool or str Draw GMT time stamp logo on plot.""", @@ -447,7 +447,7 @@ def fmt_docstring(module_func): tabular data. region : str or list *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*]. - Specify the :doc:`region ` of interest. + Specify the :doc:`region ` of interest. projection : str *projcode*\[*projparams*/]\ *width*. Select map :doc:`projection `. diff --git a/pygmt/src/grdview.py b/pygmt/src/grdview.py index 5a6c93be5ad..404fc490cc0 100644 --- a/pygmt/src/grdview.py +++ b/pygmt/src/grdview.py @@ -61,7 +61,7 @@ def grdview(self, grid, **kwargs): DataArray. region : str or list *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*]. - Specify the :doc:`region ` of interest. + Specify the :doc:`region ` of interest. When used with ``perspective``, optionally append */zmin/zmax* to indicate the range to use for the 3-D axes [Default is the region in the input grid].