tomo-Text.right_pad.3

(39 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.right_pad 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.right_pad \- right-pad text
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.right_pad\ :\ func(text:\ Text,\ width:\ Int,\ pad:\ Text\ =\ "\ ",\ language:\ Text\ =\ "C"\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Pad some text on the right side so it reaches a target width.
  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 pad. 	-
  26 width	Int	The target width. 	-
  27 pad	Text	The padding text. 	"\ "
  28 language	Text	The ISO 639 language code for which character width to use. 	"C"
  29 .TE
  30 .SH RETURN
  31 Text with length at least `width`, with extra padding on the right as needed. If `pad` has length greater than 1, it may be partially repeated to reach the exact desired length.
  32 
  33 .SH EXAMPLES
  34 .EX
  35 assert "x".right_pad(5) == "x    "
  36 assert "x".right_pad(5, "ABC") == "xABCA"
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-Text (3)