chn/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2026-01-12 01:50:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

treewide: convert all option docs to Markdown

Browse Source 
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
This commit is contained in:
Emily
2023-07-01 00:30:13 +01:00
parent c1d8d2a3d1
commit 36a53d9f26
355 changed files with 3805 additions and 3886 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
modules/programs/gh.nix
View File

@@ -21,14 +21,14 @@ let
pv = "pr view";
}
'';
description = ''
description = lib.mdDoc ''
Aliases that allow you to create nicknames for gh commands.
'';
};
editor = mkOption {
type = types.str;
default = "";
description = ''
description = lib.mdDoc ''
The editor that gh should run when creating issues, pull requests, etc.
If blank, will refer to environment.
'';
@@ -37,7 +37,7 @@ let
type = types.str;
default = "https";
example = "ssh";
description = ''
description = lib.mdDoc ''
The protocol to use when performing Git operations.
'';
};
@@ -63,20 +63,20 @@ in {
];
options.programs.gh = {
enable = mkEnableOption "GitHub CLI tool";
enable = mkEnableOption (lib.mdDoc "GitHub CLI tool");
package = mkOption {
type = types.package;
default = pkgs.gh;
defaultText = literalExpression "pkgs.gh";
description = "Package providing <command>gh</command>.";
description = lib.mdDoc "Package providing {command}`gh`.";
};
settings = mkOption {
type = settingsType;
default = { };
description =
"Configuration written to <filename>$XDG_CONFIG_HOME/gh/config.yml</filename>.";
description = lib.mdDoc
"Configuration written to {file}`$XDG_CONFIG_HOME/gh/config.yml`.";
example = literalExpression ''
{
git_protocol = "ssh";
@@ -92,15 +92,16 @@ in {
};
enableGitCredentialHelper =
mkEnableOption "the gh git credential helper for github.com" // {
mkEnableOption (lib.mdDoc "the gh git credential helper for github.com")
// {
default = true;
};
extensions = mkOption {
type = types.listOf types.package;
default = [ ];
description = ''
gh extensions, see <link xlink:href="https://cli.github.com/manual/gh_extension"/>.
description = lib.mdDoc ''
gh extensions, see <https://cli.github.com/manual/gh_extension>.
'';
example = literalExpression "[ pkgs.gh-eco ]";
};