Skip to content

Commit 1117143

Browse files
committed
fix failing duties
1 parent a07491f commit 1117143

2 files changed

Lines changed: 14 additions & 13 deletions

File tree

src/griffe2md/_internal/cli.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313

1414
import argparse
1515
import sys
16-
from typing import Any
16+
from typing import Any, cast
1717

1818
from griffe2md._internal import debug
19-
from griffe2md._internal.config import load_config
19+
from griffe2md._internal.config import ConfigDict, load_config
2020
from griffe2md._internal.main import write_package_docs
2121

2222

@@ -62,10 +62,10 @@ def main(args: list[str] | None = None) -> int:
6262
"""
6363
parser = get_parser()
6464
opts = parser.parse_args(args=args)
65-
config = load_config() or {}
65+
config = load_config()
6666

6767
if opts.mdformat_extensions:
68-
config["mdformat_extensions"] = opts.mdformat_extensions
68+
config = cast("ConfigDict", {**(config or {}), "mdformat_extensions": opts.mdformat_extensions})
6969

7070
write_package_docs(opts.package, config, opts.output)
7171
return 0

src/griffe2md/_internal/config.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,16 @@ def load_config() -> ConfigDict | None:
5252
return cast("ConfigDict", config)
5353

5454

55-
class ConfigDict(TypedDict):
55+
class _OptionalConfigDict(TypedDict, total=False):
56+
mdformat_extensions: list[str]
57+
"""A list of mdformat extensions to enable when formatting Markdown output.
58+
59+
For example, `["tables"]` to enable the `mdformat-tables` extension,
60+
which properly handles escaped pipes in table cells.
61+
"""
62+
63+
64+
class ConfigDict(_OptionalConfigDict):
5665
"""Configuration for griffe2md, griffe and mkdocstrings."""
5766

5867
allow_inspection: bool
@@ -103,13 +112,6 @@ class ConfigDict(TypedDict):
103112
load_external_modules: bool
104113
"""Whether to always load external modules/packages."""
105114

106-
mdformat_extensions: list[str]
107-
"""A list of mdformat extensions to enable when formatting Markdown output.
108-
109-
For example, `["tables"]` to enable the `mdformat-tables` extension,
110-
which properly handles escaped pipes in table cells.
111-
"""
112-
113115
members: list[str] | bool | None
114116
"""A boolean, or an explicit list of members to render.
115117
@@ -272,7 +274,6 @@ class ConfigDict(TypedDict):
272274
"show_docstring_functions": True,
273275
"show_docstring_modules": True,
274276
"extensions": [],
275-
"mdformat_extensions": [],
276277
"search_paths": [],
277278
}
278279
"""Default configuration values."""

0 commit comments

Comments
 (0)