diff options
Diffstat (limited to 'man/man3/tomo-Text.split.3')
| -rw-r--r-- | man/man3/tomo-Text.split.3 | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/man/man3/tomo-Text.split.3 b/man/man3/tomo-Text.split.3 index 5c6bf034..99023a8d 100644 --- a/man/man3/tomo-Text.split.3 +++ b/man/man3/tomo-Text.split.3 @@ -2,19 +2,19 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.split 3 2025-04-19T14:30:40.368084 "Tomo man-pages" +.TH Text.split 3 2025-04-19T14:48:15.717773 "Tomo man-pages" .SH NAME -Text.split \- Splits the text into a list of substrings based on exact matches of a delimiter. **Note:** to split based on a set of delimiter characters, use [`split_any()`](#split_any). +Text.split \- Splits the text into a list of substrings based on exact matches of a delimiter. .SH LIBRARY Tomo Standard Library .SH SYNOPSIS .nf -.BI "Text.split : func(text: Text, delimiter: Text = "" -> [Text])" +.BI Text.split\ :\ func(text:\ Text,\ delimiter:\ Text\ =\ ""\ ->\ [Text]) .fi .SH DESCRIPTION -Splits the text into a list of substrings based on exact matches of a delimiter. **Note:** to split based on a set of delimiter characters, use [`split_any()`](#split_any). +Splits the text into a list of substrings based on exact matches of a delimiter. .TS @@ -23,11 +23,15 @@ lb lb lbx lb l l l l. Name Type Description Default text Text The text to be split. - -delimiter Text The delimiter used to split the text. If the delimiter is the empty text, the text will be split into individual grapheme clusters. "" +delimiter Text The delimiter used to split the text. "" .TE .SH RETURN A list of subtexts resulting from the split. +.SH NOTES +To split based on a set of delimiters, use Text.split_any(). +If an empty text is given as the delimiter, then each split will be the graphical clusters of the text. + .SH EXAMPLES .EX >> "one,two,,three".split(",") |