Skip to content

Commit 7d12bae

Browse files
authored
Improve the description for the 'cores' parameter (#3923)
1 parent 4a2d45d commit 7d12bae

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

pygmt/helpers/decorators.py

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,11 @@
7171
:gmt-docs:`gmt.html#f-full`.""",
7272
"cores": r"""
7373
cores : bool or int
74-
[[**-**]\ *n*].
75-
Limit the number of cores to be used in any OpenMP-enabled
76-
multi-threaded algorithms. By default we try to use all available
77-
cores. Set a number *n* to only use n cores (if too large it will
78-
be truncated to the maximum cores available). Finally, give a
79-
negative number *-n* to select (all - *n*) cores (or at least 1 if
80-
*n* equals or exceeds all).
81-
""",
74+
Specify the number of active cores to be used in any OpenMP-enabled
75+
multi-threaded algorithms. By default, all available cores are used. Set a
76+
positive number *n* to use *n* cores (if too large it will be truncated to
77+
the maximum cores available); or set a negative number *-n* to select
78+
(all - *n*) cores (or at least 1 if *n* equals or exceeds all).""",
8279
"distcalc": r"""
8380
distcalc : str
8481
Determine how spherical distances are calculated

0 commit comments

Comments
 (0)