aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLouis Pilfold <louis@lpil.uk>2024-11-02 11:54:14 +0000
committerLouis Pilfold <louis@lpil.uk>2024-11-02 11:54:14 +0000
commit226a2ee1cfd1d6d408530c218207e6a12e31433f (patch)
treee1a67d667106cea00d1e773695df63dca2bf5fc8 /src
parentb617da1d359ce2331f5410c456302e5966e00489 (diff)
downloadgleam_stdlib-226a2ee1cfd1d6d408530c218207e6a12e31433f.tar.gz
gleam_stdlib-226a2ee1cfd1d6d408530c218207e6a12e31433f.zip
Document the definition of whitespace
Related to https://github.com/gleam-lang/stdlib/issues/717
Diffstat (limited to 'src')
-rw-r--r--src/gleam/string.gleam5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/gleam/string.gleam b/src/gleam/string.gleam
index 0f073b9..14acc23 100644
--- a/src/gleam/string.gleam
+++ b/src/gleam/string.gleam
@@ -543,6 +543,11 @@ fn padding(size: Int, pad_string: String) -> String {
/// Removes whitespace on both sides of a `String`.
///
+/// Whitespace in this function is the set of nonbreakable whitespace
+/// codepoints, defined as Pattern_White_Space in [Unicode Standard Annex #31][1].
+///
+/// [1]: https://unicode.org/reports/tr31/
+///
/// ## Examples
///
/// ```gleam