code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.sibling 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.sibling \- get another path in the same directory
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.sibling\ :\ func(path:\ Path,\ name:\ Text\ ->\ Path)
  13 .fi
  14 .SH DESCRIPTION
  15 Return a path that is a sibling of another path (i.e. has the same parent, but a different name). This is equivalent to `.parent().child(name)`
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 path	Path	A path. 
  26 name	Text	The name of a sibling file or directory. 
  27 .TE
  28 .SH RETURN
  29 A new path representing the sibling.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (/foo/baz).sibling("doop") == (/foo/doop)
  34 .EE
  35 .SH SEE ALSO
  36 .BR Tomo-Path (3)