From 5fd8914dac6ba43ea650fadec35344f20ce50544 Mon Sep 17 00:00:00 2001
From: Emily <vcs@emily.moe>
Date: Fri, 21 Jul 2023 09:15:33 +0100
Subject: treewide: fix `mkEnableOption` docs

`mkEnableOption` wraps its argument in a complete sentence with a
terminating full stop; an additional newline will add an incorrect
space before the end of the sentence in the rendered documentation,
and any additional verbiage that doesn't fit into the form "Whether to
enable [...]." is also incorrect. In the latter case, the description
can be overridden manually.
---
 modules/security/pam.nix | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

(limited to 'modules/security')

diff --git a/modules/security/pam.nix b/modules/security/pam.nix
index 0061fba..f0c77dc 100644
--- a/modules/security/pam.nix
+++ b/modules/security/pam.nix
@@ -39,17 +39,24 @@ in
 
 {
   options = {
-    security.pam.enableSudoTouchIdAuth = mkEnableOption (lib.mdDoc ''
-      Enable sudo authentication with Touch ID
+    security.pam.enableSudoTouchIdAuth = mkEnableOption "" // {
+      description = lib.mdDoc ''
+        Enable sudo authentication with Touch ID.
 
-      When enabled, this option adds the following line to /etc/pam.d/sudo:
+        When enabled, this option adds the following line to
+        {file}`/etc/pam.d/sudo`:
 
-          auth       sufficient     pam_tid.so
+        ```
+        auth       sufficient     pam_tid.so
+        ```
 
-      (Note that macOS resets this file when doing a system update. As such, sudo
-      authentication with Touch ID won't work after a system update until the nix-darwin
-      configuration is reapplied.)
-    '');
+        ::: {.note}
+        macOS resets this file when doing a system update. As such, sudo
+        authentication with Touch ID won't work after a system update
+        until the nix-darwin configuration is reapplied.
+        :::
+      '';
+    };
   };
 
   config = {
-- 
cgit v1.2.3