Open yvonnefroehlich opened 1 year ago
I try to describe this issue in PR #2383. Could you help the documentation (pygmt.Figure) more clear?
Looking at the Matplotlib tutorial, here is my understanding/preference:
plot
: A general term which can describe Cartesian, geographic, polar, or 3D "plots".map
should be limited to a geographic plot.figure
refers to the pygmt.Figure
object.
Currently, "figure" and "map" / "plot" more or less used interchangeable. However, there can be a relevant difference, mostly in the context of setting the anchor point (
position
parameter). Further, "figure" also refers more to the figure object / instance created viapygmt.Figure()
.First dicussed in https://github.com/GenericMappingTools/pygmt/pull/2395#discussion_r1131261305 by @michaelgrund:
and https://github.com/GenericMappingTools/pygmt/pull/2395#discussion_r1131330064 by @yvonnefroehlich:
This is a bit related to issue #2026 and maybe can be included in the tutorial added by @JingHuiTong in PR #2383?
This impacts mainly on the docstrings as well as gallery examples and tutorials: