POC: DOC: Add note for need to call pygmt.config after setting up pygmt.Figure instance#4735
Draft
yvonnefroehlich wants to merge 5 commits into
Draft
POC: DOC: Add note for need to call pygmt.config after setting up pygmt.Figure instance#4735yvonnefroehlich wants to merge 5 commits into
yvonnefroehlich wants to merge 5 commits into
Conversation
yvonnefroehlich
added
the
documentation
yvonnefroehlich
changed the title
yvonnefroehlich
marked this pull request as draft
July 19, 2026 11:53
seisman
reviewed
Jul 19, 2026
| .. note:: | ||
| Currently, :class:`pygmt.config` needs to be called **after** setting |
Member
There was a problem hiding this comment.
Actually, the note only make sense when multiple Figure instances are created in one session.
seisman
reviewed
Jul 20, 2026
| .. 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 |
Member
There was a problem hiding this comment.
Maybe just say "it's recommended to call pygmt.config after ..."
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
2 participants
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.
Description of proposed changes
Related to several issues, e.g., #733, #4732.
Preview: https://pygmt-dev--4735.org.readthedocs.build/en/4735/api/generated/pygmt.config.html
Guidelines
Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code