Skip to content
This repository was archived by the owner on Feb 20, 2026. It is now read-only.

Commit 581ea49

Browse files
committed
Fix sphinx warnings in the documentation
1 parent 621b0ff commit 581ea49

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

cli_ui/__init__.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,12 @@ def message(
253253

254254

255255
def fatal(*tokens: Token, exit_code: int = 1, **kwargs: Any) -> None:
256-
"""Print an error message and call ``sys.exit` with a given
257-
`exit_code` (default: 1)`"""
256+
"""Print an error message and exit the program
257+
258+
:param tokens: list of `ui` constants or strings, like
259+
``(cli_ui.red, "this is a fatal error")``
260+
:param exit_code: value of the exit code (default: 1)
261+
"""
258262
error(*tokens, **kwargs)
259263
sys.exit(exit_code)
260264

docs/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,10 +196,8 @@ Functions below use ``sys.stderr`` by default:
196196
Error: message
197197
exit(1)
198198

199-
::
200-
201199
>>> cli_ui.fatal("Another message", exit_code=2)
202-
Error: message
200+
Error: Another message
203201
exit(2)
204202

205203

0 commit comments

Comments
 (0)