Skip to content

Standardize "figure"/"map"/"plot" terminology across codebase#4418

Draft
Copilot wants to merge 6 commits intomainfrom
copilot/update-figure-map-usage
Draft

Standardize "figure"/"map"/"plot" terminology across codebase#4418
Copilot wants to merge 6 commits intomainfrom
copilot/update-figure-map-usage

Conversation

Copy link
Contributor

Copilot AI commented Feb 14, 2026

Inconsistent use of "figure", "map", and "plot" created ambiguity in documentation. Established guidelines: figure = Figure class/object, map = geographic plots only, plot = general term for all plot types (Cartesian, geographic, polar, 3D).

Changes

Documentation structure

  • doc/api/index.rst: "Plotting map elements" → "Plotting embellishments"

Examples - non-geographic contexts

  • examples/intro/03_figure_element.py: "Map Boundary" → "Plot Boundary"
  • examples/projections/nongeo/polar.py: "map limits/width" → "plot limits/width" (12 instances)
  • examples/gallery/3d_plots/scatter3d.py: "map dimensions" → "plot dimensions"
  • examples/tutorials/basics/text.py: Removed redundant "or map" qualifiers
  • examples/tutorials/advanced/configuration.py: "geographical" → "geographic"

Source docstrings

  • pygmt/src/{contour,image,text}.py: "on a map" → "on a plot"
  • pygmt/src/{plot,plot3d,grdimage}.py: "map region" → "plot region"
  • pygmt/helpers/decorators.py: "map boundary/frame" → "plot boundary/frame"
  • pygmt/src/rose.py: "map boundary frame" → "plot boundary frame"

Particularly impacts positioning parameters where distinguishing between the plot area (frame interior) and Figure object matters.

Original prompt

This section details on the original issue you should resolve

<issue_title>More careful usage of "figure" vs. "map" / "plot"?</issue_title>
<issue_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:

<agent_instructions>Read through all source files and documentation and fix incorrect usage of figure, map, and plot. More specifically, "map" refers to "geographics plots", "plot" refers to a general plot, and figure refers to the Figure class.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@jhtong33 I try to describe this issue in PR #2383. Could you help the documentation (pygmt.Figure) more clear? @seisman Looking at the [Matplotlib tutorial](https://matplotlib.org/stable/users/explain/quick_start.html#quick-start), 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.</comment_new>

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 14, 2026 10:31
- Change "plot or map" to "plot" in examples and tutorials
- Change "Map Boundary" to "Plot Boundary" in figure elements example
- Change "Plotting map elements" to "Plotting embellishments" in API docs
- Change "geographical maps" to "geographic maps" for consistency
- Update "map boundary" to "plot boundary" in decorators and rose module

Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
- Change "geographical tick annotations" to "geographic tick annotations"
- Change "map frame" to "plot frame" in 3D perspective documentation

Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Copilot AI changed the title [WIP] Clarify usage of figure vs map and plot Standardize figure/map/plot terminology across documentation Feb 14, 2026
Copilot AI requested a review from seisman February 14, 2026 10:35
Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Copilot AI changed the title Standardize figure/map/plot terminology across documentation Fix terminology: use "plot dimensions" instead of "map dimensions" in 3D scatter example Feb 14, 2026
- examples/projections/nongeo/polar.py: Changed "Set map limits" to "Set plot limits" and "Set map width" to "Set plot width" (12 instances)
- pygmt/src/contour.py: Changed "on a map" to "on a plot"
- pygmt/src/image.py: Changed "on a map" to "on a plot"
- pygmt/src/text.py: Changed "on the map" to "on the plot" and "of the map" to "of the plot"

Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Copilot AI changed the title Fix terminology: use "plot dimensions" instead of "map dimensions" in 3D scatter example Standardize "figure"/"map"/"plot" terminology across codebase Feb 14, 2026
…→ "plot region"

- pygmt/src/plot.py line 199: Changed "clipped to the map region" to "clipped to the plot region"
- pygmt/src/plot3d.py line 174: Changed "clipped to the map region" to "clipped to the plot region"
- pygmt/src/grdimage.py line 72: Changed "select a map region" to "select a plot region"

Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants