Description
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 #2395 (comment) 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 #2395 (comment) 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 29a7bb7.
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:
- Timstamp: Update see PR Figure.timestamp: Improve documentation and gallery example #2434
- Colorbars: Update see PR Minor improvement of docs of gallery example "Colorbars" #2440
- etc.