strutils.strip: improve the documentation; fixes #7159
This commit is contained in:
parent
e2094bc6f4
commit
0132442c1d
1 changed files with 3 additions and 1 deletions
|
|
@ -440,10 +440,12 @@ proc cmpIgnoreStyle*(a, b: string): int {.noSideEffect,
|
||||||
proc strip*(s: string, leading = true, trailing = true,
|
proc strip*(s: string, leading = true, trailing = true,
|
||||||
chars: set[char] = Whitespace): string
|
chars: set[char] = Whitespace): string
|
||||||
{.noSideEffect, rtl, extern: "nsuStrip".} =
|
{.noSideEffect, rtl, extern: "nsuStrip".} =
|
||||||
## Strips `chars` from `s` and returns the resulting string.
|
## Strips leading or trailing `chars` from `s` and returns
|
||||||
|
## the resulting string.
|
||||||
##
|
##
|
||||||
## If `leading` is true, leading `chars` are stripped.
|
## If `leading` is true, leading `chars` are stripped.
|
||||||
## If `trailing` is true, trailing `chars` are stripped.
|
## If `trailing` is true, trailing `chars` are stripped.
|
||||||
|
## If both are false, the string is returned unchanged.
|
||||||
var
|
var
|
||||||
first = 0
|
first = 0
|
||||||
last = len(s)-1
|
last = len(s)-1
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue