From 186ab56af1f7cb179bd62485a805d551a43f7dc2 Mon Sep 17 00:00:00 2001 From: Dima Tisnek Date: Tue, 8 Oct 2024 13:48:08 +0900 Subject: [PATCH] chore: document where the fields come from --- juju/application.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/juju/application.py b/juju/application.py index 4502d30b5..08f9db4e4 100644 --- a/juju/application.py +++ b/juju/application.py @@ -26,6 +26,16 @@ class Application(model.ModelEntity): + """Represents the current state of a deployed application. + + In the current library version, as well entire 2.x and 3.x series, + the data is supplied by Juju AllWatcher notifications, also known as deltas + for the specific application. The fields are declared here: + https://github.com/juju/juju/blob/be8a779/core/multiwatcher/types.go#L191-L209 + + The fields marked deprecated below will be removed in version 4.0 because + a different API must be used against Juju 4. + """ @property def name(self) -> str: return self.entity_id