diff options
| author | Emily <vcs@emily.moe> | 2023-06-22 09:05:03 +0100 |
|---|---|---|
| committer | Emily <vcs@emily.moe> | 2023-06-24 10:48:55 +0100 |
| commit | efe314cdbabaf5cd210d9c658b4ad540437b7ee5 (patch) | |
| tree | 8b00b1c0518922b71311ba2e0c448d6b3e5340d8 /modules/networking | |
| parent | c2716817a8e5fb47889aaf625aa13b89d786da51 (diff) | |
treewide: manually convert some docs to Markdown
These all use DocBook markup too complex for `nix-doc-munge` to handle,
have syntax that clashes with Markdown, or already contain Markdown
syntax that currently isn't rendering correctly.
Converting DocBook list syntax makes me think that maybe Markdown
isn't so bad after all.
Diffstat (limited to 'modules/networking')
| -rw-r--r-- | modules/networking/default.nix | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/modules/networking/default.nix b/modules/networking/default.nix index 46cd982..727933f 100644 --- a/modules/networking/default.nix +++ b/modules/networking/default.nix @@ -29,7 +29,7 @@ in type = types.nullOr types.str; default = null; example = "John’s MacBook Pro"; - description = '' + description = lib.mdDoc '' The user-friendly name for the system, set in System Preferences > Sharing > Computer Name. Setting this option is equivalent to running `scutil --set ComputerName`. @@ -42,7 +42,7 @@ in type = types.nullOr (types.strMatching hostnameRegEx); default = null; example = "Johns-MacBook-Pro"; - description = '' + description = lib.mdDoc '' The hostname of your system, as visible from the command line and used by local and remote networks when connecting through SSH and Remote Login. @@ -56,7 +56,7 @@ in type = types.nullOr (types.strMatching hostnameRegEx); default = cfg.hostName; example = "Johns-MacBook-Pro"; - description = '' + description = lib.mdDoc '' The local hostname, or local network name, is displayed beneath the computer's name at the top of the Sharing preferences pane. It identifies your Mac to Bonjour-compatible services. |