Figure.scalebar: Improve docstrings for parameters label_alignment/fancy - #4868
Open
seisman wants to merge 1 commit into
Open
Figure.scalebar: Improve docstrings for parameters label_alignment/fancy#4868seisman wants to merge 1 commit into
seisman wants to merge 1 commit into
Conversation
seisman
added
documentation
seisman
commented
Aug 27, 2026
| @@ -71,19 +71,20 @@ def scalebar( | |||
| [Default is ``"km"``]. Requires ``fancy=True``. | |||
| label_alignment | |||
| Alignment of the scale bar label. Choose from ``"left"``, ``"right"``, | |||
Member
Author
There was a problem hiding this comment.
| If ``True``, draw a "fancy" scale bar, which is a segmented bar with alternating | ||
| black and white rectangles. If ``False``, draw a plain scale bar. Only supported | ||
| for non-Cartesian projections. | ||
| black and white rectangles. If ``False``, draw a plain scale bar. Doesn't work |
Member
Author
There was a problem hiding this comment.
GMT allows fancy scales in Cartesian projection after GenericMappingTools/gmt#9069 (first appeared in GMT 6.7.0).
seisman
changed the title
seisman
added
final review call
Contributor
There was a problem hiding this comment.
Pull request overview
Improves the Figure.scalebar parameter docstrings to better reflect GMT’s actual defaults and version-dependent behavior, making the generated API documentation clearer and more accurate.
Changes:
- Clarify
label_alignmentdefault behavior based on scale bar orientation (horizontal vs vertical). - Update
fancydocumentation to reflect the GMT version constraint for Cartesian projections (pre-6.7.0).
💡 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.
Improve docstrings.
Preview: https://pygmt-dev--4868.org.readthedocs.build/en/4868/api/generated/pygmt.Figure.scalebar.html