From efbf556332524db0428afbc91a9bc5fdee77b60a Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Wed, 14 May 2025 22:25:47 +0100 Subject: [PATCH] treefmt: add longDescription linking to Nixpkgs Manual Link to the treefmt section of the Nixpkgs Manual in the `treefmt` package's long description. Additionally, link to treefmt-nix. --- pkgs/by-name/tr/treefmt/package.nix | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/pkgs/by-name/tr/treefmt/package.nix b/pkgs/by-name/tr/treefmt/package.nix index ab9c136ac434..0c0151b4a7b7 100644 --- a/pkgs/by-name/tr/treefmt/package.nix +++ b/pkgs/by-name/tr/treefmt/package.nix @@ -46,6 +46,19 @@ buildGoModule rec { meta = { description = "one CLI to format the code tree"; + longDescription = '' + [treefmt](${meta.homepage}) streamlines the process of applying formatters + to your project, making it a breeze with just one command line. + + The `treefmt` package provides functions for configuring treefmt using + the module system, which are documented in the [treefmt section] of the + Nixpkgs Manual. + + Alternatively, treefmt can be configured using [treefmt-nix]. + + [treefmt section]: https://nixos.org/manual/nixpkgs/unstable#treefmt + [treefmt-nix]: https://github.com/numtide/treefmt-nix + ''; homepage = "https://github.com/numtide/treefmt"; license = lib.licenses.mit; maintainers = with lib.maintainers; [