Standardize figure/map/plot terminology in codes and docs [Part 2] - #4847
Merged
Conversation
seisman
added
maintenance
Contributor
There was a problem hiding this comment.
Pull request overview
Standardizes figure, map, and plot terminology across PyGMT documentation, examples, and API docstrings.
Changes:
- Clarifies map and plot dimensions, frames, regions, and origin shifts.
- Updates terminology in tutorials, projections, and gallery examples.
- Revises technical documentation wording.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Summary |
|---|---|
pygmt/src/text.py |
Clarifies text plotting terminology. |
pygmt/src/ternary.py |
Uses plot terminology for ternary diagrams. |
pygmt/src/grdcontour.py |
Clarifies plot width. |
examples/tutorials/basics/regions.py |
Uses map terminology. |
examples/tutorials/advanced/subplots.py |
Clarifies subplot frames. |
examples/tutorials/advanced/earth_relief.py |
Uses map terminology. |
examples/tutorials/advanced/configuration.py |
Clarifies previous plot usage. |
examples/tutorials/advanced/cartesian_histograms.py |
Clarifies plot origin shifts. |
examples/projections/nongeo/cartesian_power.py |
Uses plot terminology. |
examples/projections/nongeo/cartesian_logarithmic.py |
Uses plot terminology. |
examples/projections/cyl/cyl_oblique_mercator.py |
Uses map terminology. |
examples/intro/01_first_figure.py |
Clarifies map terminology. |
examples/gallery/lines/envelope.py |
Clarifies plot origin shifts. |
examples/gallery/images/image.py |
Updates gallery terminology. |
examples/gallery/images/cross_section.py |
Clarifies plot frame terminology. |
examples/gallery/embellishments/gmt_logo.py |
Updates gallery terminology. |
doc/techref/justification_codes.md |
Updates embellishment placement terminology. Nit (3 votes): use plot consistently for the reference point instead of mixing in figure. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Comment on lines
7
to
11
| To place plot embellishments, such as scalebars, directional roses, colorbars, legends, | ||
| text, or images on a figure, two points have to be specified: a point somewhere on the | ||
| text, or images on a plot, two points have to be specified: a point somewhere on the | ||
| figure (**reference point**) and a point on the feature (**anchor point**). For both, | ||
| users can use a two-character code, a combination of a vertical code and a horizontal | ||
| code (order-independent): |
Member
There was a problem hiding this comment.
Not sure here, but besides this the PR should be fine. Maybe change "figure" in line 9 also to plot?
seisman
removed
the
final review call
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Done by Claude and manually reviewed by @seisman.
There may still be inconsistencies in the codes/docs, but I guess we can close #2437.