Sort the alias lists in docstrings alphabetically - #4855
Merged
Conversation
The "Aliases" list in docstrings is sorted by GMT option, uppercase options first, then lowercase ones. Seven docstrings had entries out of order: - Figure.choropleth: R/N and W/V - Figure.legend: D/B - Figure.solar: t/p - pygmt.grd2cpt: Z/V - pygmt.makecpt: Z/V - pygmt.project: W/V - pygmt.sph2grd: r/i Docstring-only change; the entries themselves are unchanged. Note that Figure.basemap, Figure.grdview and Figure.plot3d intentionally list 'Jz' before 'JZ', matching GMT's own '-Jz|Z' documentation order, so they are left as they are. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
seisman
added
maintenance
seisman
added
final review call
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
1 participant
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.
The Aliases list in docstrings is sorted by GMT option, with uppercase options first
and lowercase ones after. Seven docstrings had entries out of order:
Figure.choroplethR/NandW/VFigure.legendD/BFigure.solart/ppygmt.grd2cptZ/Vpygmt.makecptZ/Vpygmt.projectW/Vpygmt.sph2grdr/iThis is a docstring-only change: the entries themselves are untouched, only reordered.
I checked all 65 alias lists under
pygmt/. Three others come up as "unsorted" but areleft as they are on purpose:
Figure.basemap,Figure.grdviewandFigure.plot3dlistJzbeforeJZ, which matches GMT's own-Jz|Zdocumentation order and thezscale/zsizeparameter order in those signatures.🤖 Generated with Claude Code