Improved synopsis and usage of -Ccpt for grid plot modules #8165
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 grid plotters grd2kml, grdimage, grdview, and grdvector may take a bit more complicated CPT argument. This is now documented better via API function
gmt_explain_cpt_input
and RST include fileuse_cpt_grd.rst_
. Also standardised these four's synopsis syntax via a new constant CPT_OPT_ARGS.While making C changes this is all about documentation only. For instance, the grd2kml usage message looks like this:
and the man page looks like this now: