From cb9ff43a6cdf1b2dbf16099cf76ca9c911209db4 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Tue, 12 Nov 2019 14:50:51 +0100 Subject: [PATCH] Add new things to constellation --- royalnet/constellation/README.md | 6 ++++++ royalnet/constellation/star.py | 3 +++ 2 files changed, 9 insertions(+) diff --git a/royalnet/constellation/README.md b/royalnet/constellation/README.md index 179a0740..c14c3480 100644 --- a/royalnet/constellation/README.md +++ b/royalnet/constellation/README.md @@ -3,3 +3,9 @@ The part of `royalnet` that handles the webserver and webpages. It uses many features of [`starlette`](https://www.starlette.io). + +## Hierarchy + +- `constellation` + - `star` + - `shoot` \ No newline at end of file diff --git a/royalnet/constellation/star.py b/royalnet/constellation/star.py index 9469c2a2..e606a729 100644 --- a/royalnet/constellation/star.py +++ b/royalnet/constellation/star.py @@ -23,14 +23,17 @@ class Star: @property def alchemy(self): + """A shortcut for the :class:`Alchemy` of the :class:`Constellation`.""" return self.constellation.alchemy @property def Session(self): + """A shortcut for the alchemy :class:`Session` of the :class:`Constellation`.""" return self.constellation.alchemy.Session @property def session_acm(self): + """A shortcut for the session :func:`asynccontextmanager` of the :class:`Constellation`.""" return self.constellation.alchemy.session_acm