-
Notifications
You must be signed in to change notification settings - Fork 255
Figure.scalebar: Improve docstrings for parameters label_alignment/fancy #4868
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
seisman
wants to merge
1
commit into
main
Choose a base branch
from
scalebar/doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+6
−5
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,19 +71,20 @@ def scalebar( | |
| [Default is ``"km"``]. Requires ``fancy=True``. | ||
| label_alignment | ||
| Alignment of the scale bar label. Choose from ``"left"``, ``"right"``, | ||
| ``"top"``, or ``"bottom"`` [Default is ``"top"``]. | ||
| ``"top"``, or ``"bottom"`` [Default is ``"top"`` for horizontal scale bars and | ||
| ``"right"`` for vertical scale bars]. | ||
| fancy | ||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. GMT allows fancy scales in Cartesian projection after GenericMappingTools/gmt#9069 (first appeared in GMT 6.7.0). |
||
| for Cartesian projections for GMT<6.7.0. | ||
| unit | ||
| If ``True``, append the unit to all distance annotations along the scale. For a | ||
| plain scale, this will instead select the unit to be appended to the distance | ||
| length. The unit is determined from the suffix provided to the ``length`` | ||
| parameter or defaults to ``"km"``. | ||
| vertical | ||
| If ``True``, plot a vertical rather than a horizontal scale. Only | ||
| supported for Cartesian projections. | ||
| If ``True``, plot a vertical rather than a horizontal scale. Only supported for | ||
| Cartesian projections. | ||
| box | ||
| Draw a background box behind the scale bar. If set to ``True``, a simple | ||
| rectangular box is drawn using :gmt-term:`MAP_FRAME_PEN`. To customize the box | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
xref: GenericMappingTools/gmt#9158