Skip to content

POC: DOC: A note recommending to call pygmt.config after pygmt.Figure() #4735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
yvonnefroehlich wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

POC: DOC: A note recommending to call pygmt.config after pygmt.Figure() #4735

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cfc6352
Add note regarding config after Figure
yvonnefroehlich Jul 19, 2026
eb5abe7
Fix highlighting
yvonnefroehlich Jul 19, 2026
a7e61f6
Use rst for link
yvonnefroehlich Jul 19, 2026
7124a46
Add period
yvonnefroehlich Jul 19, 2026
12392b8
Improve formulation
yvonnefroehlich Jul 19, 2026
b3795aa
Merge branch 'main' into add-note-config
yvonnefroehlich Aug 23, 2026
656dfa4
Merge branch 'main' into add-note-config
yvonnefroehlich Sep 10, 2026
fdd2a00
Merge branch 'main' into add-note-config
yvonnefroehlich Oct 25, 2026
a9e5e78
Merge branch 'main' into add-note-config
yvonnefroehlich Nov 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions pygmt/src/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ class config: # ruff: ignore[invalid-class-name]

Full GMT defaults list at :gmt-docs:`gmt.conf.html`.

.. note::

For GMT defaults to adjust the figure appearance, e.g., the font size,
:class:`pygmt.config` needs to be called **after** setting up the

@seisman seisman Jul 20, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe just say "it's recommended to call pygmt.config after ..."

@seisman seisman Jul 30, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I feel the wording "global" and "local" are a little misleading. Perhaps we should call them "permanent" and "temporary" instead, similar to the wording we use for Figure.shift_origin.

We also need to document https://docs.generic-mapping-tools.org/dev/reference/features.html#gmt-modern-mode-hierarchical-levels, but it could be done in a separate PR.

:class:`pygmt.Figure` instance to have an effect. This is relevant for
both, global and local changes. For details see the
`GitHub issue comment <https://github.com/GenericMappingTools/pygmt/issues/733#issuecomment-744698150>`__.

.. note::

:gmt-term:`PS_CONVERT` is not supported.
Expand Down
Loading