From 39bdb24ab0a890e5109189ef85c783f7a04deb90 Mon Sep 17 00:00:00 2001 From: Arturo Seijas Date: Tue, 4 Feb 2025 10:53:13 +0100 Subject: [PATCH] docs --- src-docs/charm.py.md | 4 ++-- src-docs/state.py.md | 13 +++++++++++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/src-docs/charm.py.md b/src-docs/charm.py.md index da0e847d..4e9cbb6b 100644 --- a/src-docs/charm.py.md +++ b/src-docs/charm.py.md @@ -24,7 +24,7 @@ Charm the service. - `master_fqdn`: the FQDN for unit 0. - `state`: the charm state. - + ### function `__init__` @@ -95,7 +95,7 @@ Unit that this execution is responsible for. --- - + ### function `reconcile` diff --git a/src-docs/state.py.md b/src-docs/state.py.md index d6475932..d8bdc7fa 100644 --- a/src-docs/state.py.md +++ b/src-docs/state.py.md @@ -69,6 +69,15 @@ reconcile(_: HookEvent) → None Reconcile configuration. +--- + +## class `IncompleteStateError` +Exception raised when a charm configuration is invalid and automatically recoverable. + + + + + --- ## class `InvalidStateError` @@ -148,7 +157,7 @@ The Wazuh Server charm state. - `custom_config_ssh_key`: the SSH key for the git repository. - `proxy`: proxy configuration. - + ### function `__init__` @@ -236,7 +245,7 @@ Returns: a map containing the unconfigured users and their details. --- - + ### classmethod `from_charm`