doc: Fix some warnings (#7890)

GenericMappingTools · Oct 9, 2023 · f5b9967 · f5b9967
1 parent 08dc64b
commit f5b9967
Show file tree

Hide file tree

Showing 12 changed files with 248 additions and 245 deletions.
diff --git a/doc/rst/source/basemap.rst b/doc/rst/source/basemap.rst
@@ -198,7 +198,7 @@ A 10-cm-wide basemap using the Cassini projection may be obtained by
 
 ::
 
-gmt basemap -R20/50/20/35 -JC35/28/10c -Bafg -B+tCassini -pdf cassini
+ gmt basemap -R20/50/20/35 -JC35/28/10c -Bafg -B+tCassini -pdf cassini
 
 Mercator [conformal]
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/doc/rst/source/colorbar.rst b/doc/rst/source/colorbar.rst
@@ -205,7 +205,7 @@ Optional Arguments
 
 **-Q**
  Select logarithmic scale and power of ten annotations. All z-values
- in the CPT will be converted to p = :math:`\log_{10}`(z) and only integer p
+ in the CPT will be converted to p = :math:`\log_{10}(z)` and only integer p
  values will be annotated using the 10^p format [Default is linear scale].
 
 .. _-R:

diff --git a/doc/rst/source/gmtselect.rst b/doc/rst/source/gmtselect.rst
@@ -203,6 +203,7 @@ Optional Arguments
  entire segment (or we keep the entire segment if **+hk** was given), otherwise it is
  subject to the test(s) using the constant *z* for each segment.
  - **+i** - Reverses the tests to pass record with a *z* value **not** in the given range.
+
 .. include:: explain_-aspatial.rst_
 
 .. |Add_-bi| replace:: [Default is 2 input columns].

diff --git a/doc/rst/source/grdmath.rst b/doc/rst/source/grdmath.rst
diff --git a/doc/rst/source/grdpaste.rst b/doc/rst/source/grdpaste.rst
@@ -53,7 +53,7 @@ Optional Arguments
 
 **-S**
  Just prints a code number and a description of the sides at which the grids are pasted.
- No pasting actually happens. -G is ignored. This option is useful for externals that want to
+ No pasting actually happens. -G is ignored. This option is useful for externals that want to
  reimplement the grdpaste utility since it doesn't work form them (*e.g.* Julia and GMTMEX).
 
 .. |Add_-V| replace:: |Add_-V_links|

diff --git a/doc/rst/source/makecpt.rst b/doc/rst/source/makecpt.rst
@@ -178,7 +178,7 @@ Optional Arguments
 
 **-Q**
  For logarithmic interpolation scheme with input given as logarithms.
- Expects input z-values provided via |-T| to be :math:`\log_{10}`(*z*\ ), assigns colors, and
+ Expects input z-values provided via |-T| to be :math:`\log_{10}(z)`, assigns colors, and
  writes out *z*.
 
 .. _-S:

diff --git a/doc/rst/source/supplements/geodesy/earthtide.rst b/doc/rst/source/supplements/geodesy/earthtide.rst
@@ -97,7 +97,7 @@ Optional Arguments
  calculations. If no |-T| is provided get current time in UTC from the computer clock. If no |-G| or |-S| are
  provided then |-T| is interpreted to mean compute a time-series at the location specified by |-L|, thus then |-L|
  becomes mandatory. When |-G| and |-T|, only first time T series is considered. Finally, dates may range from 1901
- through 2099. For details on array creation, see `Generate 1D Array`_.
+ through 2099. For details on array creation, see `Generate 1-D Array`_.
 
 .. |Add_-bo| unicode:: 0x20 .. just an invisible code
 .. include:: ../../explain_-bo.rst_

diff --git a/doc/rst/source/supplements/potential/gmtflexure.rst b/doc/rst/source/supplements/potential/gmtflexure.rst
@@ -73,7 +73,7 @@ Required Arguments
  simply driven by the boundary conditions set via |-A|. If no rigidity or
  elastic thickness file is given via |-E| then you must also append arguments
  to create the locations used for the calculations; for details on array creation,
- see `Generate 1D Array`_.
+ see `Generate 1-D Array`_.
  **-Qq**\ [*loadfile*] is a file (or standard input if not given) with (x,load in Pa)
  for all equidistant data locations. Finally, **-Qt**\ [*topofile*] is a file
  (or standard input if not given) with (x,load in m or km, positive up); see |-M| for

diff --git a/doc/rst/source/supplements/potential/talwani2d.rst b/doc/rst/source/supplements/potential/talwani2d.rst
@@ -92,7 +92,7 @@ Optional Arguments
 
 **-T**\ *min*\ /*max*\ /\ *inc*\ [**+i**\|\ **n**]\ \|\ *file*\|\ *list*
  Specify an equidistant output lattice.
- For details on array creation, see `Generate 1D Array`_.
+ For details on array creation, see `Generate 1-D Array`_.
 
 .. |Add_-V| replace:: |Add_-V_links|
 .. include:: /explain_-V.rst_

diff --git a/doc/rst/source/supplements/windbarbs/grdbarb.rst b/doc/rst/source/supplements/windbarbs/grdbarb.rst
@@ -1,4 +1,5 @@
 .. index:: ! grdbarb
+.. include:: ../module_supplements_purpose.rst_
 
 *******
 grdbarb
@@ -85,7 +86,7 @@ Optional Arguments
  the grid's z-range. If the dynamic CPT has a default range then
  that range will be imposed instead.
  Yet another option is to specify -Ccolor1,color2[,color3,...]
- to build a linear continuous cpt from those colors automatically. 
+ to build a linear continuous cpt from those colors automatically.
  In this case *color*\ **n** can be a r/g/b triplet, a color name,
  or an HTML hexadecimal color (e.g. #aabbcc ).
 
@@ -100,14 +101,14 @@ Optional Arguments
  Only plot wind barbs at nodes every *x\_inc*, *y\_inc* apart (must be
  multiples of original grid spacing). Append **m** for arc minutes or
  **s** for arc seconds. Alternatively, use **-Ix** to specify the
- multiples *multx*\ [/*multy*] directly [Default plots every node]. 
+ multiples *multx*\ [/*multy*] directly [Default plots every node].
 
 .. include:: ../../explain_-K.rst_
 
 .. _-N:
 
 **-N**
- Do NOT clip wind barbs at map boundaries [Default will clip]. 
+ Do NOT clip wind barbs at map boundaries [Default will clip].
 
 .. _-Q:
 
@@ -142,7 +143,7 @@ Optional Arguments
 
 **-W**\ *pen*
  Set pen attributes used for wind barb outlines [Default: width =
- default, color = black, style = solid]. 
+ default, color = black, style = solid].
 
 .. |Add_-XY| replace:: |Add_-XY_links|
 .. include:: ../../explain_-XY.rst_
@@ -152,7 +153,7 @@ Optional Arguments
 .. _-Z:
 
 **-Z**
- The theta grid provided contains azimuths rather than directions (implies **-A**). 
+ The theta grid provided contains azimuths rather than directions (implies **-A**).
 
 .. |Add_-f| unicode:: 0x20 .. just an invisible code
 .. include:: ../../explain_-f.rst_
@@ -164,7 +165,7 @@ Optional Arguments
 
 .. include:: ../../explain_help.rst_
 
-.. include:: ../../explain_grd_inout_short.rst_
+.. include:: ../../explain_grd_inout.rst_
 
 .. include:: explain_windbarbs.rst_
 

diff --git a/doc/rst/source/tutorial/intro.rst b/doc/rst/source/tutorial/intro.rst
@@ -39,7 +39,7 @@ GMT modules. GMT uses architecture-independent file formats.
 GMT installation considerations
 -------------------------------
 
-See the :doc:`install guide <install>`
+See the :doc:`install guide </install>`
 for instructions and to make sure you have all required dependencies installed.
 Alternatively, you can build GMT from source by following the
 `building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.

diff --git a/doc/rst/source/tutorial/intro_jl.rst b/doc/rst/source/tutorial/intro_jl.rst
@@ -26,7 +26,7 @@ architecture-independent file formats.
 GMT installation considerations
 -------------------------------
 
-See the :doc:`install guide <install>`
+See the :doc:`install guide </install>`
 for instructions and to make sure you have all required dependencies installed.
 Alternatively, you can build GMT from source by following the
 `building guide <https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md>`_.