JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lib.trimWith: Minor doc improvements

Browse Source
This commit is contained in:
Silvan Mosberger 2024-07-26 01:16:49 +02:00
parent 91a3ba9064
commit 60027e7836
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/strings.nix
View File

@ -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: