From 60027e7836d9b8041f6a610fdcdd84973e7bf8c0 Mon Sep 17 00:00:00 2001
From: Silvan Mosberger <silvan.mosberger@tweag.io>
Date: Fri, 26 Jul 2024 01:16:49 +0200
Subject: lib.trimWith: Minor doc improvements

---
 lib/strings.nix | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'lib/strings.nix')

diff --git a/lib/strings.nix b/lib/strings.nix
index 18ef707750bb..49c625e232c0 100644
--- a/lib/strings.nix
+++ b/lib/strings.nix
@@ -176,11 +176,12 @@ rec {
 
   /*
     Remove leading and/or trailing whitespace from a string.
+    To remove both leading and trailing whitespace, you can also use [`trim`](#function-library-lib.strings.trim)
 
     Whitespace is defined as any of the following characters:
       " ", "\t" "\r" "\n"
 
-    Type: trimWith :: Attrs -> string -> string
+    Type: trimWith :: { start ? false, end ? false } -> string -> string
 
     Example:
       trimWith { start = true; } "   hello, world!   "}
@@ -190,9 +191,9 @@ rec {
   */
   trimWith =
     {
-      # Trim leading whitespace
+      # Trim leading whitespace (`false` by default)
       start ? false,
-      # Trim trailing whitespace
+      # Trim trailing whitespace (`false` by default)
       end ? false,
     }:
     s:
-- 
cgit v1.2.3