Skip to content

Figure.basemap: Improve the docstring for coltypes - #4856

Open
seisman wants to merge 5 commits into
mainfrom
basemap/coltypes
Open

Figure.basemap: Improve the docstring for coltypes#4856
seisman wants to merge 5 commits into
mainfrom
basemap/coltypes

Conversation

@seisman

@seisman seisman commented Aug 25, 2026

Copy link
Copy Markdown
Member

Usually, the -f option sets the data types of input/output columns. But in basemap, it only sets the coordinate types specified in the -R option (xref: https://docs.generic-mapping-tools.org/dev/basemap.html). So the common description for coltypes makes no sense in Figure.basemap.

This PR fixes the docstring for coltypes in Figure.basemap to clarify it.

Preview: https://pygmt-dev--4856.org.readthedocs.build/en/4856/api/generated/pygmt.Figure.basemap.html#pygmt.Figure.basemap

@seisman seisman added this to the 0.20.0 milestone Aug 25, 2026
@seisman
seisman requested a lite review from Copilot August 25, 2026 02:45
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog final review call This PR requires final review and approval from a second reviewer labels Aug 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This pull request updates pygmt.Figure.basemap documentation to clarify that coltypes (the GMT -f option) applies specifically to the coordinate types used by region (-R) in basemap, rather than the more general “input/output column types” meaning used by many other modules.

Changes:

  • Replaced the generic $coltypes docstring template in basemap with a basemap-specific coltypes description and a link to the GMT basemap -f documentation.
  • Minor reflow/wording edits in the basemap docstring introduction.
  • (Unintended) Reordered the verbose parameter position in the function signature, which can be backward-incompatible for positional callers.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread pygmt/src/basemap.py
@seisman seisman added the documentation Improvements or additions to documentation label Aug 26, 2026
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 final review call This PR requires final review and approval from a second reviewer maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants