aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.parent.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/tomo-Path.parent.3')
-rw-r--r--man/man3/tomo-Path.parent.316
1 files changed, 9 insertions, 7 deletions
diff --git a/man/man3/tomo-Path.parent.3 b/man/man3/tomo-Path.parent.3
index 1e81ab7c..57c4a4a5 100644
--- a/man/man3/tomo-Path.parent.3
+++ b/man/man3/tomo-Path.parent.3
@@ -2,14 +2,14 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.parent 3 2025-11-09 "Tomo man-pages"
+.TH Path.parent 3 2025-12-07 "Tomo man-pages"
.SH NAME
Path.parent \- get parent directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI Path.parent\ :\ func(path:\ Path\ ->\ Path)
+.BI Path.parent\ :\ func(path:\ Path\ ->\ Path?)
.fi
.SH DESCRIPTION
Returns the parent directory of the file or directory at the specified path.
@@ -19,15 +19,17 @@ Returns the parent directory of the file or directory at the specified path.
.TS
allbox;
-lb lb lbx lb
-l l l l.
-Name Type Description Default
-path Path The path of the file or directory. -
+lb lb lbx
+l l l.
+Name Type Description
+path Path The path of the file or directory.
.TE
.SH RETURN
-The path of the parent directory.
+The path of the parent directory or `none` if the path is `(/)` (the file root).
.SH EXAMPLES
.EX
assert (./path/to/file.txt).parent() == (./path/to/)
.EE
+.SH SEE ALSO
+.BR Tomo-Path (3)