Expand docstring about peer data

canonical · Oct 9, 2023 · 49c916a · 49c916a
1 parent d06f34f
commit 49c916a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/src-docs/secret_storage.py.md b/src-docs/secret_storage.py.md
@@ -13,7 +13,7 @@ Helper module used to manage interactions with Synapse secrets.
 
 ---
 
-<a href="../src/secret_storage.py#L64"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/secret_storage.py#L68"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `get_admin_access_token`
 

diff --git a/src/secret_storage.py b/src/secret_storage.py
@@ -24,6 +24,10 @@
 def _update_peer_data(charm: ops.CharmBase, container: ops.model.Container) -> None:
     """Update peer data if needed.
 
+    The admin access token is stored in a Secret (Juju 3) or in a peer relation
+    data. If already exists, no action is taken. Otherwise, will create an admin
+    user and store the token.
+
     Args:
         charm: The charm object.
         container: Synapse container.
-Original file line number
+Diff line change
@@ Expand Up @@
     ---
-    <a href="../src/secret_storage.py#L64"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+    <a href="../src/secret_storage.py#L68"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
     ## <kbd>function</kbd> `get_admin_access_token`
@@ Expand Down @@