WIP: DOC/Figure.paragraph: Add a gallery example to show formating long text as paragraphs #4592
Draft
yvonnefroehlich wants to merge 6 commits intomainfrom
Draft
WIP: DOC/Figure.paragraph: Add a gallery example to show formating long text as paragraphs #4592yvonnefroehlich wants to merge 6 commits intomainfrom
yvonnefroehlich wants to merge 6 commits intomainfrom
Conversation
yvonnefroehlich
added
the
documentation
Member
I think it makes more sense to have a separate example.
I feel these are technical details that users don't have to know, especially for PyGMT users who are not familiar with GMT CLI syntax. |
seisman
reviewed
Apr 21, 2026
| Paragraph | ||
| ========= | ||
|
|
||
| To plot longer text as one or several paragraphs the `pygmt.Figure.paragraph` |
Member
There was a problem hiding this comment.
Suggested change
| To plot longer text as one or several paragraphs the `pygmt.Figure.paragraph` | |
| To plot longer text as one or several paragraphs the :meth:`pygmt.Figure.paragraph` |
Comment on lines
+7
to
+8
| the line length and spacing of the paragraph, respectively.` Two paragraphs are | ||
| automatically separated by a blank line. |
Member
There was a problem hiding this comment.
Better to mention that, multiple paragraphs can be passed in two forms: (1) as a single string separated by a blank line; (2) as a list of strings.
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
This PR aims to add a gallery example to show the usage of the newly added high-level method
Figure.paragraph.Currently this is a standalone example. I am a bit wondering if it can make sense to add this to the already existing gallery example Formatting text because
Figure.paragraphis related to -M ofFigure.text.Please note the upstream bug reported in #4590. I will write a related GMT code example and issue hopefully this night or tomorrow - Edit upstream bug report at GenericMappingTools/gmt#8989.
Preview:
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