From 1f93bccb1fbc48ccad48fc3c0e231d37f276c190 Mon Sep 17 00:00:00 2001 From: zeevdr Date: Sun, 7 Jun 2026 15:38:49 +0300 Subject: [PATCH] docs: fix configuration.md ConfigValue references The Return types section documented a ConfigValue dataclass (with field_path, value, checksum, description fields) that does not exist in the package, causing an ImportError for anyone trying to import it. Replace it with the real third dataclass, ServerVersion (version, commit), and clarify that get_all() returns a plain dict[str, str] mapping field paths to their string values rather than a dataclass. Closes #134 --- sdk/docs/configuration.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/sdk/docs/configuration.md b/sdk/docs/configuration.md index 6103b82..3623149 100644 --- a/sdk/docs/configuration.md +++ b/sdk/docs/configuration.md @@ -204,16 +204,10 @@ All exceptions inherit from `DecreeError`: ## Return types -All return types are frozen dataclasses: +`get_all()` returns a plain `dict[str, str]` mapping field paths to their string +values — not a dataclass. The other typed return values are frozen dataclasses: ```python -@dataclass(frozen=True, slots=True) -class ConfigValue: - field_path: str - value: str - checksum: str - description: str - @dataclass(frozen=True, slots=True) class Change: field_path: str @@ -221,4 +215,9 @@ class Change: new_value: str | None version: int changed_by: str + +@dataclass(frozen=True, slots=True) +class ServerVersion: + version: str + commit: str ```