Figure.basemap: Improve the docstring for coltypes - #4856
Open
seisman wants to merge 2 commits into
Open
Conversation
seisman
added
maintenance
Contributor
There was a problem hiding this comment.
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
$coltypesdocstring template inbasemapwith a basemap-specificcoltypesdescription and a link to the GMTbasemap -fdocumentation. - Minor reflow/wording edits in the
basemapdocstring introduction. - (Unintended) Reordered the
verboseparameter 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.
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
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.
Usually, the
-foption sets the data types of input/output columns. But inbasemap, it only sets the coordinate types specified in the-Roption (xref: https://docs.generic-mapping-tools.org/dev/basemap.html). So the common description forcoltypesmakes no sense inFigure.basemap.This PR fixes the docstring for
coltypesinFigure.basemapto clarify it.Preview: https://pygmt-dev--4856.org.readthedocs.build/en/4856/api/generated/pygmt.Figure.basemap.html#pygmt.Figure.basemap