Skip to content
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.

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

doc: Fix some warnings #7890

Merged
merged 1 commit into from
Oct 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
doc: Fix some warnings
  • Loading branch information
seisman committed Oct 9, 2023
commit 6b865551b2e8b5e21d8aa4ef2f38f35d343d00c9
2 changes: 1 addition & 1 deletion doc/rst/source/basemap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]
~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/colorbar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions doc/rst/source/gmtselect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down
461 changes: 231 additions & 230 deletions doc/rst/source/grdmath.rst

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/rst/source/grdpaste.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/makecpt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/supplements/geodesy/earthtide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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_
Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/supplements/potential/gmtflexure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/supplements/potential/talwani2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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_
Expand Down
13 changes: 7 additions & 6 deletions doc/rst/source/supplements/windbarbs/grdbarb.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. index:: ! grdbarb
.. include:: ../module_supplements_purpose.rst_

*******
grdbarb
Expand Down Expand Up @@ -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 ).

Expand All @@ -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:

Expand Down Expand Up @@ -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_
Expand All @@ -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_
Expand All @@ -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_

Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/tutorial/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/tutorial/intro_jl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
Expand Down