nixos/matrix-authentication-service: fix formatting of description

Be more explicit in the first sentence. And use code-blocks to make sure the code-example is rendered correctly.
2026-07-04 12:23:03 +02:00
parent 0d214bd808
commit 084023c72a
1 changed files with 6 additions and 3 deletions
@@ -379,13 +379,16 @@ in
      type = lib.types.attrsOf lib.types.str;
      default = { };
      description = ''
-        Name -> source file path. Exposed to the unit via LoadCredential and
-        readable inside the service at ''${CREDENTIALS_DIRECTORY}/<name>.
+        Mapping of credential name to  source file-path. Exposed to the unit via LoadCredential and
+        readable inside the service at `''${CREDENTIALS_DIRECTORY}/<name>`.

-        For example :
+        For example:
+
+        ```
        services.matrix-authentication-service.credentials."synapse-secret" = "/run/agenix/synapse-shared";
        services.matrix-authentication-service.settings.matrix.secret_file =
          "\''${CREDENTIALS_DIRECTORY}/synapse-secret";
+        ```
      '';
    };
  };