Skip to content

Commit

Permalink
set docdict alphabetically
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathieu Scheltienne committed Jan 2, 2024
1 parent ad72d02 commit 4c3a625
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions template/utils/_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,44 @@
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"``,
``"ERROR"``, ``"WARNING"``, ``"INFO"`` and ``"DEBUG"``. If None is provided, the
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()


Expand Down

0 comments on commit 4c3a625

Please sign in to comment.