docstrings for crypto, database and email

sydent/config/crypto.py

@@ -11,6 +11,13 @@
 
 class CryptoConfig(BaseConfig):
     def parse_config(self, cfg: ConfigParser):
+        """
+        Parse the crypto section of the config
+
+        Args:
+            cfg (ConfigParser): the configuration to be parsed
+        """
+
         signing_key_str = cfg.get("crypto", "ed25519.signingkey")
         signing_key_parts = signing_key_str.split(" ")
 
@@ -48,4 +55,6 @@ def parse_config(self, cfg: ConfigParser):
                 signedjson.key.encode_signing_key_base64(self.signing_key),
             )
             cfg.set("crypto", "ed25519.signingkey", signing_key_str)
+
+            # This will trigger the updated cfg to be saved to file
             self.update_cfg = True

sydent/config/database.py

@@ -5,4 +5,10 @@
 
 class DatabaseConfig(BaseConfig):
     def parse_config(self, cfg: ConfigParser):
+        """
+        Parse the database section of the config
+
+        Args:
+            cfg (ConfigParser): the configuration to be parsed
+        """
         self.database_path = cfg.get("db", "db.file")

sydent/config/email.py

@@ -6,6 +6,12 @@
 
 class EmailConfig(BaseConfig):
     def parse_config(self, cfg: ConfigParser):
+        """
+        Parse the email section of the config
+
+        Args:
+            cfg (ConfigParser): the configuration to be parsed
+        """
 
         self.template = None
         if cfg.has_option("email", "email.template"):
@@ -21,7 +27,6 @@ def parse_config(self, cfg: ConfigParser):
         if self.host_name == "":
             self.host_name = socket.getfqdn()
 
-        # These are deprecated options as subject is now set by templates
         self.validation_subject = cfg.get("email", "email.subject")
         self.invite_subject = cfg.get("email", "email.invite.subject", raw=True)
         self.invite_subject_space = cfg.get(