blob: a3bf2136d36fb057c130cfa2da7b4d63849458e5 (
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.relative_to 3 2025-11-29 "Tomo man-pages"
.SH NAME
Path.relative_to \- apply a relative path to another
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.relative_to\ :\ func(path:\ Path,\ relative_to\ =\ (./)\ ->\ Path)
.fi
.SH DESCRIPTION
Returns the path relative to a given base path. By default, the base path is the current directory.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
path Path The path to convert. -
relative_to The base path for the relative path. (./)
.TE
.SH RETURN
The relative path.
.SH EXAMPLES
.EX
assert (./path/to/file.txt).relative(relative_to=(./path)) == (./to/file.txt)
.EE
.SH SEE ALSO
.BR Tomo-Path (3)
|
