tomo-Text.split.3

(41 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.split 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.split \- split a text by a delimiter
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.split\ :\ func(text:\ Text,\ delimiter:\ Text\ =\ ""\ ->\ [Text])
  13 .fi
  14 .SH DESCRIPTION
  15 Splits the text into a list of substrings based on exact matches of a delimiter.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 text	Text	The text to be split. 	-
  26 delimiter	Text	The delimiter used to split the text. 	""
  27 .TE
  28 .SH RETURN
  29 A list of subtexts resulting from the split.
  30 
  31 .SH NOTES
  32 To split based on a set of delimiters, use Text.split_any().
  33 If an empty text is given as the delimiter, then each split will be the graphical clusters of the text.
  34 
  35 .SH EXAMPLES
  36 .EX
  37 assert "one,two,,three".split(",") == ["one", "two", "", "three"]
  38 assert "abc".split() == ["a", "b", "c"]
  39 .EE
  40 .SH SEE ALSO
  41 .BR Tomo-Text (3)