From 1f04b970b712d827b60d9f5a6288f6445228ad0b Mon Sep 17 00:00:00 2001 From: Michael Grund <23025878+michaelgrund@users.noreply.github.com> Date: Tue, 8 Feb 2022 18:38:47 +0100 Subject: [PATCH 1/5] Add inline example for blockmedian --- pygmt/src/blockm.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/pygmt/src/blockm.py b/pygmt/src/blockm.py index 67c241dcc50..8bfebc84928 100644 --- a/pygmt/src/blockm.py +++ b/pygmt/src/blockm.py @@ -225,7 +225,15 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs): is not set. - None if ``outfile`` is set (filtered output will be stored in file set by ``outfile``). - """ + + Examples + -------- + >>> import pygmt # doctest: +SKIP + >>> # Load a table of ship observations of bathymetry off Baja California + >>> data = pygmt.datasets.load_sample_bathymetry() + >>> # Calculate block median values within 5 by 5 minute bins + >>> data_bmedian = pygmt.blockmedian(data = data, region=[245, 255, 20, 30], spacing = "5m") # doctest: +SKIP + """ return _blockm( block_method="blockmedian", data=data, x=x, y=y, z=z, outfile=outfile, **kwargs ) From 2ea4c083e7498a9b4487a761fdcf6cc9879b02f7 Mon Sep 17 00:00:00 2001 From: Michael Grund Date: Tue, 8 Feb 2022 19:10:15 +0100 Subject: [PATCH 2/5] format --- pygmt/src/blockm.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/pygmt/src/blockm.py b/pygmt/src/blockm.py index 8bfebc84928..e0ddb085325 100644 --- a/pygmt/src/blockm.py +++ b/pygmt/src/blockm.py @@ -225,15 +225,17 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs): is not set. - None if ``outfile`` is set (filtered output will be stored in file set by ``outfile``). - + Examples -------- >>> import pygmt # doctest: +SKIP >>> # Load a table of ship observations of bathymetry off Baja California >>> data = pygmt.datasets.load_sample_bathymetry() >>> # Calculate block median values within 5 by 5 minute bins - >>> data_bmedian = pygmt.blockmedian(data = data, region=[245, 255, 20, 30], spacing = "5m") # doctest: +SKIP - """ + >>> data_bmedian = pygmt.blockmedian( + ... data=data, region=[245, 255, 20, 30], spacing="5m" + ... ) # doctest: +SKIP + """ return _blockm( block_method="blockmedian", data=data, x=x, y=y, z=z, outfile=outfile, **kwargs ) From 86302d8c5215c9ad0993b64fa0eabf17bff5b162 Mon Sep 17 00:00:00 2001 From: Michael Grund Date: Thu, 10 Feb 2022 17:36:58 +0100 Subject: [PATCH 3/5] update based on code review --- pygmt/src/blockm.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pygmt/src/blockm.py b/pygmt/src/blockm.py index e0ddb085325..d193d9d5a83 100644 --- a/pygmt/src/blockm.py +++ b/pygmt/src/blockm.py @@ -226,8 +226,8 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs): - None if ``outfile`` is set (filtered output will be stored in file set by ``outfile``). - Examples - -------- + Example + ------- >>> import pygmt # doctest: +SKIP >>> # Load a table of ship observations of bathymetry off Baja California >>> data = pygmt.datasets.load_sample_bathymetry() From fb96e9b44d1d1d8f862d195fae35e3cefad559f7 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sun, 13 Feb 2022 12:45:27 +0800 Subject: [PATCH 4/5] Update pygmt/src/blockm.py Co-authored-by: Meghan Jones --- pygmt/src/blockm.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pygmt/src/blockm.py b/pygmt/src/blockm.py index d193d9d5a83..60560d6dd8c 100644 --- a/pygmt/src/blockm.py +++ b/pygmt/src/blockm.py @@ -230,7 +230,7 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs): ------- >>> import pygmt # doctest: +SKIP >>> # Load a table of ship observations of bathymetry off Baja California - >>> data = pygmt.datasets.load_sample_bathymetry() + >>> data = pygmt.datasets.load_sample_data(name='bathymetry') >>> # Calculate block median values within 5 by 5 minute bins >>> data_bmedian = pygmt.blockmedian( ... data=data, region=[245, 255, 20, 30], spacing="5m" From baf8a8f3fa356e702fda5ee6259bc4a8dff1f7a6 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sun, 13 Feb 2022 14:25:42 +0800 Subject: [PATCH 5/5] Fix formatting issue --- pygmt/src/blockm.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pygmt/src/blockm.py b/pygmt/src/blockm.py index 60560d6dd8c..8b1612a61e1 100644 --- a/pygmt/src/blockm.py +++ b/pygmt/src/blockm.py @@ -230,7 +230,7 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs): ------- >>> import pygmt # doctest: +SKIP >>> # Load a table of ship observations of bathymetry off Baja California - >>> data = pygmt.datasets.load_sample_data(name='bathymetry') + >>> data = pygmt.datasets.load_sample_data(name="bathymetry") >>> # Calculate block median values within 5 by 5 minute bins >>> data_bmedian = pygmt.blockmedian( ... data=data, region=[245, 255, 20, 30], spacing="5m"