aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Text.replace.3
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
commit67fd3c725e6511adf70345f0733ec0b948477a11 (patch)
tree913d9f30d8ce3614a9ae3715281f8804323b24ff /man/man3/tomo-Text.replace.3
parent0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff)
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Text.replace.3')
-rw-r--r--man/man3/tomo-Text.replace.336
1 files changed, 36 insertions, 0 deletions
diff --git a/man/man3/tomo-Text.replace.3 b/man/man3/tomo-Text.replace.3
new file mode 100644
index 00000000..4b7993fc
--- /dev/null
+++ b/man/man3/tomo-Text.replace.3
@@ -0,0 +1,36 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Text.replace 3 2025-04-19T14:30:40.367925 "Tomo man-pages"
+.SH NAME
+Text.replace \- Replaces occurrences of a target text with a replacement text.
+
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI "Text.replace : func(text: Text, target: Text, replacement: Text -> Text)"
+.fi
+
+.SH DESCRIPTION
+Replaces occurrences of a target text with a replacement text.
+
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+text Text The text in which to perform replacements. -
+target Text The target text to be replaced. -
+replacement Text The text to replace the target with. -
+.TE
+.SH RETURN
+The text with occurrences of the target replaced.
+
+.SH EXAMPLES
+.EX
+>> "Hello world".replace("world", "there")
+= "Hello there"
+.EE