aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.sibling.3
blob: 7d4bbd0429760dfcdbc50e55cc2d441f54166fb1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.sibling 3 2025-11-29 "Tomo man-pages"
.SH NAME
Path.sibling \- get another path in the same directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.sibling\ :\ func(path:\ Path,\ name:\ Text\ ->\ Path)
.fi
.SH DESCRIPTION
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)`


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
path	Path	A path. 	-
name	Text	The name of a sibling file or directory. 	-
.TE
.SH RETURN
A new path representing the sibling.

.SH EXAMPLES
.EX
assert (/foo/baz).sibling("doop") == (/foo/doop)
.EE
.SH SEE ALSO
.BR Tomo-Path (3)