GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
745 stars 216 forks source link

More careful usage of "figure" vs. "map" / "plot"? #2437

Open yvonnefroehlich opened 1 year ago

yvonnefroehlich commented 1 year ago

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 via pygmt.Figure().

First dicussed in https://github.com/GenericMappingTools/pygmt/pull/2395#discussion_r1131261305 by @michaelgrund:

In my opinion "figure" is not correct here, since the whole object is the figure, including the area outside the map frame where the colorbar is placed.

and https://github.com/GenericMappingTools/pygmt/pull/2395#discussion_r1131330064 by @yvonnefroehlich:

I see your point. My intention to change it was that the generated figure is no geographical map. Maybe "plot" would serve as a more general term? But I am not sure whether there is a clear differentiation between "plot" and "figure". Thus, I changed it back to "map" in commit https://github.com/GenericMappingTools/pygmt/commit/29a7bb76eed7636ee74d126f54327be04d0040f1.

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:

jhtong33 commented 1 year ago

I try to describe this issue in PR #2383. Could you help the documentation (pygmt.Figure) more clear?

seisman commented 1 month ago

Looking at the Matplotlib tutorial, here is my understanding/preference: