Skip to content

Conversation

@seisman
Copy link
Member

@seisman seisman commented Feb 10, 2026

@seisman seisman added this to the 0.19.0 milestone Feb 10, 2026
@seisman seisman added the enhancement Improving an existing feature label Feb 10, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 10, 2026

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status Path
added pygmt/tests/baseline/test_basemap_frame_none.png

Image diff(s)

Details

Added images

  • test_basemap_frame_none.png

Modified images

Path Old New

Report last updated at commit 3fe7c7b

@seisman seisman added the needs review This PR has higher priority and needs review. label Feb 10, 2026
@seisman seisman requested a review from Copilot February 10, 2026 07:09
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a Pythonic frame="none" option across PyGMT plotting APIs to request “no frame” behavior by translating it to GMT’s -B+n under the hood.

Changes:

  • Map frame="none" to the GMT -B+n syntax in the alias system (common -B handling).
  • Expand frame type annotations across affected plotting functions to include Literal["none"].
  • Add/extend tests, baseline image, and update docs/examples to demonstrate the new syntax.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pygmt/alias.py Implements the frame="none"+n mapping for common -B handling.
pygmt/helpers/decorators.py Updates common frame docstring snippet to document frame="none".
pygmt/src/basemap.py Updates frame type hint to accept "none".
pygmt/src/coast.py Updates frame type hint to accept "none".
pygmt/src/colorbar.py Updates frame type hint and documents frame="none" behavior.
pygmt/src/contour.py Updates frame type hint to accept "none".
pygmt/src/grdcontour.py Updates frame type hint to accept "none".
pygmt/src/grdimage.py Updates frame type hint to accept "none".
pygmt/src/grdview.py Updates frame type hint to accept "none".
pygmt/src/histogram.py Updates frame type hint to accept "none".
pygmt/src/image.py Updates frame type hint to accept "none".
pygmt/src/legend.py Updates frame type hint to accept "none".
pygmt/src/meca.py Updates frame type hint to accept "none".
pygmt/src/plot.py Updates frame type hint to accept "none".
pygmt/src/plot3d.py Updates frame type hint to accept "none".
pygmt/src/rose.py Updates frame type hint to accept "none".
pygmt/src/solar.py Updates frame type hint to accept "none".
pygmt/src/subplot.py Updates frame type hint to accept "none".
pygmt/src/ternary.py Updates frame type hint to accept "none".
pygmt/src/text.py Updates frame type hint to accept "none".
pygmt/src/tilemap.py Updates frame type hint to accept "none".
pygmt/src/velo.py Updates frame type hint to accept "none".
pygmt/src/wiggle.py Updates frame type hint to accept "none".
pygmt/tests/test_alias_system.py Adds coverage asserting frame="none" becomes -B+n via common-parameter aliasing.
pygmt/tests/test_basemap.py Adds an image-comparison test covering frame="none" in basemap and colorbar.
pygmt/tests/baseline/test_basemap_frame_none.png.dvc Adds the baseline artifact metadata for the new image test.
examples/gallery/maps/choropleth_map.py Updates an example to use frame="none" instead of raw "+n".

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Improving an existing feature high-priority needs review This PR has higher priority and needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Pythonic implemention of the frame="+n" setting

1 participant