Skip to content

Update the module request template to include related GMT configurations#4412

Open
seisman wants to merge 1 commit intomainfrom
template/module
Open

Update the module request template to include related GMT configurations#4412
seisman wants to merge 1 commit intomainfrom
template/module

Conversation

@seisman
Copy link
Member

@seisman seisman commented Feb 13, 2026

Inspired by #4010 (comment), we may improve the API by wrapping some GMT configurations as method parameters. One such example is the MAP_SCALE_HEIGHT which is wrapped as the height parameter in Figure.scalebar.

So it would be better to list related GMT configurations in the wrapper tracker issues.

@seisman seisman added this to the 0.19.0 milestone Feb 13, 2026
@seisman seisman requested a review from Copilot February 13, 2026 08:11
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Feb 13, 2026
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

This PR updates the module request issue template to include a new section for listing related GMT configurations. This change supports the established practice in PyGMT of wrapping GMT configuration parameters as method parameters, as exemplified by the MAP_SCALE_HEIGHT configuration being wrapped as the height parameter in Figure.scalebar.

Changes:

  • Added a new "Related GMT configurations" section to the module request template
  • Positioned the new section between "GMT Option Flags and Modifiers" and "Notes on Input Formats"
  • Included placeholder text to guide users to list relevant GMT configurations

💡 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

maintenance Boring but important stuff for the core devs 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.

1 participant