From 4c3a625bb0f3587c26e3bbe61970f84bf7a4cee7 Mon Sep 17 00:00:00 2001 From: Mathieu Scheltienne Date: Tue, 2 Jan 2024 13:09:05 +0100 Subject: [PATCH] set docdict alphabetically --- template/utils/_docs.py | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/template/utils/_docs.py b/template/utils/_docs.py index ca8de61f..8451fa1b 100644 --- a/template/utils/_docs.py +++ b/template/utils/_docs.py @@ -12,10 +12,31 @@ if TYPE_CHECKING: from typing import Any, Callable -# ------------------------- Documentation dictionary ------------------------- +# -- Documentation dictionary ---------------------------------------------------------- docdict: dict[str, str] = dict() -# ---------------------------------- verbose --------------------------------- +# -- A --------------------------------------------------------------------------------- +# -- B --------------------------------------------------------------------------------- +# -- C --------------------------------------------------------------------------------- +# -- D --------------------------------------------------------------------------------- +# -- E --------------------------------------------------------------------------------- +# -- F --------------------------------------------------------------------------------- +# -- G --------------------------------------------------------------------------------- +# -- H --------------------------------------------------------------------------------- +# -- I --------------------------------------------------------------------------------- +# -- J --------------------------------------------------------------------------------- +# -- K --------------------------------------------------------------------------------- +# -- L --------------------------------------------------------------------------------- +# -- M --------------------------------------------------------------------------------- +# -- N --------------------------------------------------------------------------------- +# -- O --------------------------------------------------------------------------------- +# -- P --------------------------------------------------------------------------------- +# -- Q --------------------------------------------------------------------------------- +# -- R --------------------------------------------------------------------------------- +# -- S --------------------------------------------------------------------------------- +# -- T --------------------------------------------------------------------------------- +# -- U --------------------------------------------------------------------------------- +# -- V --------------------------------------------------------------------------------- docdict["verbose"] = """ verbose : int | str | bool | None Sets the verbosity level. The verbosity increases gradually between ``"CRITICAL"``, @@ -23,7 +44,12 @@ verbosity is set to ``"WARNING"``. If a bool is provided, the verbosity is set to ``"WARNING"`` for False and to ``"INFO"`` for True.""" -# ------------------------- Documentation functions -------------------------- +# -- W --------------------------------------------------------------------------------- +# -- X --------------------------------------------------------------------------------- +# -- Y --------------------------------------------------------------------------------- +# -- Z --------------------------------------------------------------------------------- + +# -- Documentation functions ----------------------------------------------------------- docdict_indented: dict[int, dict[str, str]] = dict()