tomo-List.insert.3

(45 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.insert 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.insert \- add an item to a list
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.insert\ :\ func(list:\ @[T],\ item:\ T,\ at:\ Int\ =\ 0\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Inserts an element at a specified position in the list.
  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 list	@[T]	The mutable reference to the list. 	-
  26 item	T	The item to be inserted. 	-
  27 at	Int	The index at which to insert the item. 	0
  28 .TE
  29 .SH RETURN
  30 Nothing.
  31 
  32 .SH NOTES
  33 Since indices are 1-indexed and negative indices mean "starting from the back", an index of `0` means "after the last item".
  34 
  35 .SH EXAMPLES
  36 .EX
  37 list := &[10, 20]
  38 list.insert(30)
  39 assert list == [10, 20, 30]
  40 
  41 list.insert(999, at=2)
  42 assert list == [10, 999, 20, 30]
  43 .EE
  44 .SH SEE ALSO
  45 .BR Tomo-List (3)