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

nearneighbor.rst: unit is optional for -S #8374

Merged
merged 1 commit into from
Feb 17, 2024
Merged
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
nearneighbor.rst: unit is optional for -S
  • Loading branch information
anbj committed Feb 16, 2024
commit 75a21f79944b010a5556bf84eab5220483182044
7 changes: 4 additions & 3 deletions doc/rst/source/nearneighbor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Synopsis
**gmt nearneighbor** [ *table* ] |-G|\ *outgrid*
|SYN_OPT-I|
|SYN_OPT-R|
|-S|\ *search_radius*
|-S|\ *search_radius*\ [*unit*]
[ |-E|\ *empty* ]
[|-N|\ *sectors*\ [**+m**\ *min_sectors*]\ \|\ **n**]
[ |SYN_OPT-V| ]
Expand Down Expand Up @@ -92,9 +92,10 @@ Required Arguments

.. _-S:

**-S**\ *search_radius*
**-S**\ *search_radius*\ [*unit*]
Sets the *search_radius* that determines which data points are
considered close to a node. Append the distance unit (see `Units`_).
considered close to a node. Append the distance unit (see `Units`_)
if input is geographic coordinates.

Optional Arguments
------------------
Expand Down