Fix documentation of strutils.stripLineEnd (#17883)

It does not return anything.
This commit is contained in:
Michael Krieger 2021-04-28 20:33:08 +02:00 • committed by GitHub
commit 7637cff9cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2812,7 +2812,7 @@ func strip*(s: string, leading = true, trailing = true,
result = substr(s, first, last) result = substr(s, first, last)
func stripLineEnd*(s: var string) = func stripLineEnd*(s: var string) =
## Returns `s` stripped from one of these suffixes: ## Strips one of these suffixes from `s` in-place:
## `\r, \n, \r\n, \f, \v` (at most once instance). ## `\r, \n, \r\n, \f, \v` (at most once instance).
## For example, can be useful in conjunction with `osproc.execCmdEx`. ## For example, can be useful in conjunction with `osproc.execCmdEx`.
## aka: `chomp`:idx: ## aka: `chomp`:idx: