mirror of
https://github.com/LnL7/nix-darwin.git
synced 2024-12-14 11:57:34 +00:00
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.
This commit is contained in:
parent
61662a63bf
commit
5fd8914dac
3 changed files with 18 additions and 14 deletions
|
@ -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;
|
||||
|
|
|
@ -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 = {
|
||||
|
|
|
@ -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;
|
||||
|
|
Loading…
Reference in a new issue