Skip to content

Improve comments/descriptions of inline examples for plotting methods - #4939

Open
seisman wants to merge 3 commits into
mainfrom
doctest/improve
Open

seisman wants to merge 3 commits into
mainfrom
doctest/improve

Conversation

@seisman

@seisman seisman commented Oct 4, 2026

Copy link
Copy Markdown
Member

Changes include:

  • Ensure each inline example has at least one-sentence description
  • Remove some trivial comments like Create a new plot with pygmt.Figure(), Show the plot
  • Rewrap a few comments

@seisman seisman added this to the 0.20.0 milestone Oct 4, 2026
@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Oct 4, 2026

@yvonnefroehlich yvonnefroehlich left a comment •

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 would make the headings consistent and use either plural or singular (independent of the number of examples). I prefer plural, i.e. "Examples", as we use plural also for the heading for the gallery examples below.

@seisman

seisman commented Oct 4, 2026

Copy link
Copy Markdown
Member Author

I would make the headings consistent and use either plural or singular (independent of the number of examples). I prefer plural, i.e. "Examples", as we us plural also for the heading for the gallery examples below.

That's a good point. I'll address it in a separate PR and also update our "Style Checks" workflow to enforce the style.

This branch has not been deployed

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

Labels

documentation Improvements or additions to documentation needs review This PR has higher priority and needs review. skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants