Skip to content

Commit b66f421

Browse files
committed
Rewrap docstrings
1 parent 8f96038 commit b66f421

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

pygmt/helpers/decorators.py

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -159,27 +159,24 @@
159159
160160
Blank lines and lines starting with \# are always skipped.""",
161161
"incols": r"""
162-
incols : str or 1-D array
163-
Specify data columns for primary input in arbitrary order. Columns
164-
can be repeated and columns not listed will be skipped [Default
165-
reads all columns in order, starting with the first (i.e., column
166-
0)].
167-
168-
- For *1-D array*: specify individual columns in input order (e.g.,
169-
``incols=[1,0]`` for the 2nd column followed by the 1st column).
170-
- For :py:class:`str`: specify individual columns or column
171-
ranges in the format *start*\ [:*inc*]:*stop*, where *inc*
172-
defaults to 1 if not specified, with columns and/or column ranges
173-
separated by commas (e.g., ``incols="0:2,4+l"`` to input the
174-
first three columns followed by the log-transformed 5th column).
175-
To read from a given column until the end of the record, leave
176-
off *stop* when specifying the column range. To read trailing
177-
text, add the column **t**. Append the word number to **t** to
178-
ingest only a single word from the trailing text. Instead of
179-
specifying columns, use ``incols="n"`` to simply read numerical
180-
input and skip trailing text. Optionally, append one of the
181-
following modifiers to any column or column range to transform
182-
the input columns:
162+
incols
163+
Specify data columns for primary input in arbitrary order. Columns can be
164+
repeated and columns not listed will be skipped [Default reads all columns
165+
in order, starting with the first (i.e., column 0)].
166+
167+
- For a sequence: specify individual columns in input order (e.g.,
168+
``incols=(1, 0)`` for the 2nd column followed by the 1st column).
169+
- For a string: specify individual columns or column ranges in the format
170+
*start*\ [:*inc*]:*stop*, where *inc* defaults to 1 if not specified, with
171+
columns and/or column ranges separated by commas (e.g.,
172+
``incols="0:2,4+l"`` to input the first three columns followed by the
173+
log-transformed 5th column). To read from a given column until the end of
174+
the record, leave off *stop* when specifying the column range. To read
175+
trailing text, add the column **t**. Append the word number to **t** to
176+
ingest only a single word from the trailing text. Instead of specifying
177+
columns, use ``incols="n"`` to simply read numerical input and skip
178+
trailing text. Optionally, append one of the following modifiers to any
179+
column or column range to transform the input columns:
183180
184181
- **+l** to take the *log10* of the input values.
185182
- **+d** to divide the input values by the factor *divisor* [Default is 1].

0 commit comments

Comments
 (0)