diff options
author | Eli Schwartz <eschwartz@archlinux.org> | 2023-07-28 12:11:42 -0400 |
---|---|---|
committer | Eli Schwartz <eschwartz@archlinux.org> | 2023-07-28 12:13:42 -0400 |
commit | 1b8dcbcc5782a7809d23d5bff1baeb5fee74068e (patch) | |
tree | a4a53cdb1eaa6057e1ed666b601390f2fe8dccf6 /docs/yaml | |
parent | 9eb7fe332f6a6a8babd040b76ad2a6808faf0423 (diff) | |
download | meson-1b8dcbcc5782a7809d23d5bff1baeb5fee74068e.zip meson-1b8dcbcc5782a7809d23d5bff1baeb5fee74068e.tar.gz meson-1b8dcbcc5782a7809d23d5bff1baeb5fee74068e.tar.bz2 |
docs: clarify what str.split does
The wording was a bit confusing and misled at least one person into
thinking it behaved like `str.replace('c', '')` operating on the entire
line. Tweak the wording to be more precise and avoid this confusion.
Diffstat (limited to 'docs/yaml')
-rw-r--r-- | docs/yaml/elementary/str.yml | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/yaml/elementary/str.yml b/docs/yaml/elementary/str.yml index dca6382..7c48c5d 100644 --- a/docs/yaml/elementary/str.yml +++ b/docs/yaml/elementary/str.yml @@ -61,7 +61,10 @@ methods: # str.strip() - name: strip - description: Removes leading/ending spaces and newlines from the string. + description: | + Removes leading/ending characters from the string. + + By default the characters to remove are spaces and newlines. returns: str example: | ```meson @@ -75,7 +78,8 @@ methods: strip_chars: type: str since: 0.43.0 - description: All characters in this string will be stripped. + description: + description: Instead of whitespace, strip all the characters in this string. # str.to_lower() - name: to_lower |