Figure.grdcontour: Adjust processing of arguments passed to the "annotation" and "interval" parameters, deprecate "sequence_plus" #3116
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,11 +58,11 @@ def grdcontour(self, grid, **kwargs): | |
| contours specified in ``interval``. | ||
|
|
||
| - Specify a fixed annotation interval *annot_int* or a | ||
| single annotation level **+**\ *annot_int*. | ||
| - Disable all annotation with **-**. | ||
| - Optional label modifiers can be specified as a single string | ||
| ``"annot_int+e+f10p+gred"`` or with a list of arguments | ||
| ``[annot_int, "e", "f10p", "gred"]``. | ||
|
There was a problem hiding this comment. I am wondering whether here the squared brackets are used to indicate that The rounded brackets should be replaced by squared brackets as we write "list of arguments". There was a problem hiding this comment. I don't think the description is correct. In the PyGMT world, a list of arguments means the option is repeatable. For example There was a problem hiding this comment. Hm. I tried the following code to understand the input expected by # orientated on https://www.pygmt.org/dev/api/generated/pygmt.Figure.grdcontour.html
# last access: 2024/03/18
import pygmt
region = [-92.5, -82.5, -3, 7]
grid = pygmt.datasets.load_earth_relief(resolution="15m", region=region)
fig = pygmt.Figure()
fig.grdcontour(
projection="M10c",
region=region,
grid=grid,
# annotation="500+f10p+gred", # string -> WORKS
# annotation=([500], "f10p", "gred"), # -> FAILS
# annotation=(500, "f10p", "gred"), # -> WORKS
annotation=[500, "f10p", "gred"], # list -> WORKS
frame=True,
)
fig.show()
# fig.savefig(fname="grdcontour_A_string.png")
# fig.savefig(fname="grdcontour_A_list.png")Output figure There was a problem hiding this comment. Lines 30 to 32 in 6fd4a00 I see. It's because Actually, this is the only parameter that sets to There was a problem hiding this comment. I think we should disallow the syntax like
So, I think we should remove There was a problem hiding this comment. I was actually also a bit wondering if we need this possibility, as such a list does not improve the readability significantly compared to the corresponding string. So, I think I am fine with removing |
||
| limit : str or list of 2 ints | ||
| *low*/*high*. | ||
| Do no draw contours below `low` or above `high`, specify as string | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.