code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.parent 3 2025-12-07 "Tomo man-pages"
   6 .SH NAME
   7 Path.parent \- get parent directory
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.parent\ :\ func(path:\ Path\ ->\ Path?)
  13 .fi
  14 .SH DESCRIPTION
  15 Returns the parent directory of the file or directory at the specified path.
  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	The path of the file or directory. 
  26 .TE
  27 .SH RETURN
  28 The path of the parent directory or `none` if the path is `(/)` (the file root).
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert (./path/to/file.txt).parent() == (./path/to/)
  33 .EE
  34 .SH SEE ALSO
  35 .BR Tomo-Path (3)