From c625a324bac82799b478879d5f347d73b5df5bdc Mon Sep 17 00:00:00 2001 From: Fabian Boehm Date: Mon, 25 Nov 2024 17:53:14 +0100 Subject: [PATCH] docs/string-trim: Double down on the set of chars vs string thing --- doc_src/cmds/string-trim.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc_src/cmds/string-trim.rst b/doc_src/cmds/string-trim.rst index 2e6ed048b..f62c07394 100644 --- a/doc_src/cmds/string-trim.rst +++ b/doc_src/cmds/string-trim.rst @@ -18,7 +18,11 @@ Description .. BEGIN DESCRIPTION -``string trim`` removes leading and trailing whitespace from each *STRING*. If **-l** or **--left** is given, only leading whitespace is removed. If **-r** or **--right** is given, only trailing whitespace is trimmed. The **-c** or **--chars** switch causes the characters in *CHARS* to be removed instead of whitespace. Exit status: 0 if at least one character was trimmed, or 1 otherwise. +``string trim`` removes leading and trailing whitespace from each *STRING*. If **-l** or **--left** is given, only leading whitespace is removed. If **-r** or **--right** is given, only trailing whitespace is trimmed. + +The **-c** or **--chars** switch causes the set of characters in *CHARS* to be removed instead of whitespace. This is a set of characters, not a string - if you pass ``-c foo``, it will remove any "f" or "o", not just "foo" as a whole. + +Exit status: 0 if at least one character was trimmed, or 1 otherwise. .. END DESCRIPTION