Skip to content

Commit bf00b6b

Browse files
authored
DOC: Add a page for common parameters in the Technical Reference section (#3844)
1 parent e452dfb commit bf00b6b

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

doc/techref/common_parameters.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Common Parameters
2+
3+
```{glossary}
4+
``verbose``
5+
Select verbosity level, which modulates the messages written to stderr.
6+
7+
Choose among 7 levels of verbosity [Default is ``"w"``]:
8+
9+
- ``"q"``: Quiet, not even fatal error messages are produced
10+
- ``"e"``: Error messages only
11+
- ``"w"``: Warnings [Default]
12+
- ``"t"``: Timings (report runtimes for time-intensive algorithms)
13+
- ``"i"``: Informational messages (same as ``verbose=True``)
14+
- ``"c"``: Compatibility warnings
15+
- ``"d"``: Debugging messages
16+
```

doc/techref/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ visit the {gmt-docs}`GMT Technical Reference <reference.html>`.
88
```{toctree}
99
:maxdepth: 1
1010
11+
common_parameters.md
1112
projections.md
1213
fonts.md
1314
patterns.md

pygmt/helpers/decorators.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -364,16 +364,7 @@
364364
in the image (for further processing). """,
365365
"verbose": r"""
366366
verbose : bool or str
367-
Select verbosity level [Default is **w**], which modulates the messages
368-
written to stderr. Choose among 7 levels of verbosity:
369-
370-
- **q**: Quiet, not even fatal error messages are produced
371-
- **e**: Error messages only
372-
- **w**: Warnings [Default]
373-
- **t**: Timings (report runtimes for time-intensive algorithms)
374-
- **i**: Informational messages (same as ``verbose=True``)
375-
- **c**: Compatibility warnings
376-
- **d**: Debugging messages""",
367+
Select verbosity level [:term:`Full usage <verbose>`].""",
377368
"wrap": r"""
378369
wrap : str
379370
**y**\|\ **a**\|\ **w**\|\ **d**\|\ **h**\|\ **m**\|\ **s**\|\

0 commit comments

Comments
 (0)