Skip to content

DOC: Complete list of aliases #3945

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.

Sign up for GitHub

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

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

DOC: Complete list of aliases #3945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
227e80c
DOC: Complete list of aliases
seisman May 11, 2025
71a9126
New style for list of aliases
seisman May 14, 2025
8529daf
Merge branch 'main' into doc/alias-list
seisman May 14, 2025
710dde2
Merge branch 'main' into doc/alias-list
seisman May 14, 2025
4fa8af8
Merge branch 'main' into doc/alias-list
seisman May 25, 2025
093e630
Merge branch 'main' into doc/alias-list
seisman May 27, 2025
dcf8605
Merge branch 'main' into doc/alias-list
seisman Jun 2, 2025
9358dc1
Merge branch 'main' into doc/alias-list
seisman Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pygmt/src/grdclip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ def grdclip(
Full GMT docs at :gmt-docs:`grdclip.html`.

{aliases}
- G = outgrid
- Sa = above
- Sb = below
- Si = between
- Sr = replace
Comment on lines 54 to +59
Copy link
Member Author

@seisman seisman May 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The {aliases} placeholder will be expanded to something like:

.. hlist:: 
   :columns: 3
   
   - R = region
   - J = projection

Currently, the solution is to add the missing aliases below the {aliases} placeholder. Does it look bad? Perhaps we should maintain the full list of aliases manually, i.e., remove the {aliases} placeholder and manually add all aliases.

Copy link
Member Author

Choose a reason for hiding this comment

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

Perhaps we should maintain the full list of aliases manually, i.e., remove the {aliases} placeholder and manually add all aliases.

See the changes in grdfill.py for another style.

Copy link
Member

Choose a reason for hiding this comment

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

From my current understanding, I prefer the style of grdfill.py.
An overall alphabetical order makes it much easier to find a specific alias within the list.
The missing aliases have to be added manually anyway. As the aliases directly related to GMT flags will very likely not change (and if only very little), I think we have to add the list of these aliases and then this should be fine.


Parameters
----------
Expand Down
12 changes: 11 additions & 1 deletion pygmt/src/grdfill.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,17 @@ def grdfill(

Full GMT docs at :gmt-docs:`grdfill.html`.

{aliases}
.. rubric:: Aliases:
.. hlist::
:columns: 3

- A = constantfill/gridfill/neighborfill/splinefill
- G = outgrid
- L = inquire
- N = hole
- R = region
- V = verbose
- f = coltypes

Parameters
----------
Expand Down
Loading