tomo-Text.title.3

(39 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.title 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.title \- titlecase
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.title\ :\ func(text:\ Text,\ language:\ Text\ =\ "C"\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Converts the text to title case (capitalizing the first letter of each word).
  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 converted to title case. 	-
  26 language	Text	The ISO 639 language code for which casing rules to use. 	"C"
  27 .TE
  28 .SH RETURN
  29 The text in title case.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert "amélie".title() == "Amélie"
  34 
  35 # In Turkish, uppercase "i" is "İ"
  36 assert "i".title(language="tr_TR") == "İ"
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-Text (3)