Skip to content

Fix minor documentation errors #5670

@maxrjones

Description

@maxrjones

Description of the problem

Here is a list of small errors in the GMT documentation that need fixing:

  • sph2grd
    • Add -Q option to the restructured text documentation (run gmt sph2grd -? in terminal to find out information about -Q)
  • gmtvector
    • Add -bo to the list of optional arguments
  • grdtrack
    • Specify that the f|p|m|r directives for the -A argument are optional by wrapping in brackets [ ]
    • Add "If no tables are given then we read from standard input, unless -E is set" to the description of the table argument.
    • Change [+a|+v] to [+a|v] in the description of the -C argument
  • grdcontour
    • Change -A[n]|[contours] to -A[n|contours] in the argument description
  • gmtinfo - Add [Default is i] to the -F argument description.
  • gmtselect
    • Add -a common option
    • Change -E[fn] to -E[f][n]
  • grd2cpt
    • Change -Tstart/stop/inc to -Tstart/stop/inc|n
    • Add -o to the list of optional argument descriptions
  • grd2xyz
    • Add -h to the list of optional argument descriptions
  • gmtconnect
    • Add -a common option
  • gmtconvert
    • Change -F[c|n|r|v] to -F[c|n|p|v] in the synopsis
  • sphinterpolate
    • Add -i to the optional argument descriptions
    • Add -T to the synopsis
  • grdcut
    • Move -R from optional arguments list to required arguments list
  • grdfft
    • Remove brackets [ ] around -G in the synopsis
    • Add -h common option
  • gmtbinstats
    • Add -a common options
  • grdhisteq
    • Add brackets around -R and -V in synopsis
    • Add -h common option
  • grdtrend
    • Add -V to synopsis
  • grdvector
    • Add -V to synopsis
  • grdview
    • Add -V to synopsis
  • grdvolume
    • Add -h common option
  • kml2gmt
    • Add -h common option
  • sample1d
    • Specify that the f|p|m|r|R directives are optional by wrapping in brackets
  • wiggle
    • Add -X and -Y to the list of optional argument descriptions
  • surface
    • Add -W option (run gmt surface -? to find information)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprove documentationgood first issueGood for newcomershelp wantedWe need some help!workshopIssues and pull requests associated with a GMT workshop

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions