From 6e5c68be85c6c626ff52cbcdda655d5cf05ea344 Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Mon, 19 May 2025 22:13:58 +0100 Subject: [PATCH] treefmt: improve how doc-comments render in the manual 1. Use internal links for other manual sections 2. Fix definition-list syntax Currently, `:doc` doesn't support rendering clickable links anyway, so we don't loose much by having relative links. --- pkgs/by-name/tr/treefmt/lib.nix | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/pkgs/by-name/tr/treefmt/lib.nix b/pkgs/by-name/tr/treefmt/lib.nix index c5eb56d3c138..a38fb5354bca 100644 --- a/pkgs/by-name/tr/treefmt/lib.nix +++ b/pkgs/by-name/tr/treefmt/lib.nix @@ -15,9 +15,8 @@ # Inputs - : A treefmt module. See [options reference]. - - [options reference]: https://nixos.org/manual/nixpkgs/unstable#sec-treefmt-options-reference + `module` + : A treefmt module. See [options reference](#sec-treefmt-options-reference). */ evalConfig = module: @@ -49,9 +48,8 @@ # Inputs - : A treefmt module. See [options reference]. - - [options reference]: https://nixos.org/manual/nixpkgs/unstable#sec-treefmt-options-reference + `module` + : A treefmt module. See [options reference](#sec-treefmt-options-reference). */ withConfig = module: @@ -75,7 +73,8 @@ # Inputs `settings` - : A settings module, used to build a treefmt config file + : A settings module, used to build a treefmt config file. + See [`settings` option reference](#opt-treefmt-settings). */ buildConfig = module: