tomo-List.to.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.to 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 List.to \- slice a list to an end index
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.to\ :\ func(list:\ [T],\ last:\ Int\ ->\ [T])
  13 .fi
  14 .SH DESCRIPTION
  15 Returns a slice of the list from the start of the original list up to a specified index (inclusive).
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 list	[T]	The original list. 
  26 last	Int	The index up to which elements should be included. 
  27 .TE
  28 .SH RETURN
  29 A new list containing elements from the start up to the specified index.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert [10, 20, 30, 40, 50].to(3) == [10, 20, 30]
  34 assert [10, 20, 30, 40, 50].to(-2) == [10, 20, 30, 40]
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-List (3)