Complete documentation for grdtrack

[weiji14]

Description of proposed changes

Finish up aliasing parameters for grdtrack, improving the documentattion to be better than what we currently have at https://www.pygmt.org/v0.3.1/api/generated/pygmt.grdtrack.html! For reference, upstream GMT docs is at https://docs.generic-mapping-tools.org/6.1/grdtrack.html and https://github.com/GenericMappingTools/gmt/blame/master/doc/rst/source/grdtrack.rst.

Preview at https://pygmt-git-complete-docs-grdtrack-gmt.vercel.app/api/generated/pygmt.grdtrack.html

TODO:

Arguments/Aliases to document (see also https://www.generic-mapping-tools.org/GMT.jl/dev/#GMT.grdtrack). New aliases are highlighted in bold:

• A - resample
• C - crossprofile
• D - dfile?
• E - profile
• F - critical ?
• G - outfile (but not really an alias...)
• N - no_skip
• R - region
• S - stack
• T - radius
• V - verbose
• Z - z_only
• f - coltypes
• i - incols
• j - distcalc
• n - interpolation

Finalizes #307. Note: Merge this PR after #1189.

Reminders

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• Add new public functions/methods/classes to doc/api/index.rst.
• Write detailed docstrings for all functions/methods.
• If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

• /format: automatically format and lint the code
• /test-gmt-dev: run full tests on the latest GMT development version

[maxrjones]

What is the convention for including separators in the aliases? Here it seems as if partial words are concatenated without a separator (e.g., distcalc) while full words are separated with an underscore (e.g. cross_profile). But at least one of the planned aliases for the common options (skiprows) is two full words concatenated without a separator #48 (comment). In a quick search I did not find any established guidelines for this topic; it would be helpful to have this documented given all the conversations and development about long options and aliases happening.

[weiji14]

What is the convention for including separators in the aliases?

There isn't a policy yet I think, so how about this. Use an underscore to separate words bridged by vowels (aeiou), e.g. no_skip, z_only, etc. Don't use underscore for others, e.g. distcalc, crossprofile (I'll change this) and coltypes. What do you think?

[maxrjones]

What is the convention for including separators in the aliases?

There isn't a policy yet I think, so how about this. Use an underscore to separate words bridged by vowels (aeiou), e.g. no_skip, z_only, etc. Don't use underscore for others, e.g. distcalc, crossprofile (I'll change this) and coltypes. What do you think?

Very nice!

[maxrjones]

For reference, here is what GMT.jl uses:
A - interp_path
C - equidistant
D - dfile
E - by_coord
G - grid
N - no_skip
S - stack
T - radius
Z - z_only