summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmily <vcs@emily.moe>2023-07-21 09:15:33 +0100
committerEmily <vcs@emily.moe>2023-07-21 21:17:59 +0100
commit5fd8914dac6ba43ea650fadec35344f20ce50544 (patch)
treeae6981fa855940bb6ca0a38cd76f66840690f01e
parent61662a63bfe1726588c1da6b412df86d8ca94d63 (diff)
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.
-rw-r--r--modules/homebrew.nix3
-rw-r--r--modules/security/pam.nix23
-rw-r--r--modules/services/synergy/default.nix6
3 files changed, 18 insertions, 14 deletions
diff --git a/modules/homebrew.nix b/modules/homebrew.nix
index 4951d7f..05d86b9 100644
--- a/modules/homebrew.nix
+++ b/modules/homebrew.nix
@@ -536,8 +536,7 @@ in
[](#opt-homebrew.onActivation).
This module also provides a few options for modifying how Homebrew commands behave when
- you manually invoke them, under [](#opt-homebrew.global)
- '');
+ you manually invoke them, under [](#opt-homebrew.global)'');
brewPrefix = mkOption {
type = types.str;
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 = {
diff --git a/modules/services/synergy/default.nix b/modules/services/synergy/default.nix
index 95daf37..9933fe6 100644
--- a/modules/services/synergy/default.nix
+++ b/modules/services/synergy/default.nix
@@ -54,8 +54,7 @@ in
Using this requires a TLS certificate that can be
generated by starting the Synergy GUI once and entering
- a valid product key.
- '');
+ a valid product key'');
cert = mkOption {
type = types.nullOr types.str;
default = null;
@@ -102,8 +101,7 @@ in
Using this requires a TLS certificate that can be
generated by starting the Synergy GUI once and entering
- a valid product key.
- '');
+ a valid product key'');
cert = mkOption {
type = types.nullOr types.str;
default = null;