Migrate the 'no_clip' parameter to the new alias system #4103
Conversation
seisman
added
maintenance
| no_clip | ||
| Do **not** clip contours or image at the frame boundaries [Default is ``False`` | ||
| to fit inside ``region``]. |
There was a problem hiding this comment.
I am wondering to what "image" is refering here.
There was a problem hiding this comment.
It comes from the upstream documentation at https://docs.generic-mapping-tools.org/6.5/contour.html#n.
Here "image" is used because contour can color the triangles using a CPT. See the example below:
gmt begin map
gmt makecpt -Cseis -T600/1000/100
gmt basemap -R0.5/6/0.5/6 -JX10c/10c -Baf
gmt plot @Table_5_11.txt -Sc0.2c
gmt contour @Table_5_11.txt -Wthin -C -I -N -t50
gmt end show
| - J = projection | ||
| - N = no_clip | ||
| - V = verbose | ||
| - c = panel | ||
| - t = transparency |
There was a problem hiding this comment.
| - J = projection | |
| - N = no_clip | |
| - V = verbose | |
| - c = panel | |
| - t = transparency | |
| - J = projection | |
| - N = no_clip | |
| - V = verbose | |
| - c = panel | |
| - t = transparency |
There was a problem hiding this comment.
Hm, not sure what GitHub is doing here, but actually I only removed one whitespace before the newly added bullet point for -N.
There was a problem hiding this comment.
Why do you want to remove one whitespace before -N? I believe the current one is correct. See https://pygmt-dev--4103.org.readthedocs.build/en/4103/api/generated/pygmt.Figure.grdimage.html#pygmt.Figure.grdimage
There was a problem hiding this comment.
Actually, I am unsure. Directly on GitHub it looks like all bullet points have the same number of leading whitespaces, but when I look at it in the suggestion view, it seems like there is one whitespace more for -N:
| github | suggestion view |
|---|---|
 |
 |
There was a problem hiding this comment.
Same for me with the new GitHub UX. It's more likely a GitHub bug.
There was a problem hiding this comment.
Yeah, I experienced some unexpected behavior in the last days... Then we just leave this as is and in case one of the lists is not correctly aligned, we can still make a PR to fix this.
Some wrappers have the
no_clipparameter, which can be either False or True. This PR migrates the parameter to the new alias system.no_clipinFigure.plotandFigure.plot3dare not updated in this PR, because in these two methods,no_clipcan be False, True,"c"or"r"and we need to discuss the long-form arguments for "c"/"r". So leave it to a separate PR instead.