tomo-Text.quoted.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.quoted 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.quoted \- add quotation marks and escapes
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.quoted\ :\ func(text:\ Text,\ color:\ Bool\ =\ no,\ quotation_mark:\ Text\ =\ `"`\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Formats the text with quotation marks and escapes.
  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 quoted. 	-
  26 color	Bool	Whether to add color formatting. 	no
  27 quotation_mark	Text	The quotation mark to use. 	`"`
  28 .TE
  29 .SH RETURN
  30 The text formatted as a quoted text.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 assert "one\[rs]ntwo".quoted() == "\[rs]"one\[rs]\[rs]ntwo\[rs]""
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Text (3)