tomo-Path.relative_to.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.relative_to 3 2025-12-07 "Tomo man-pages"
   6 .SH NAME
   7 Path.relative_to \- apply a relative path to another
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.relative_to\ :\ func(path:\ Path,\ relative_to\ =\ (./)\ ->\ Path)
  13 .fi
  14 .SH DESCRIPTION
  15 Returns the path relative to a given base path. By default, the base path is the current directory.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 path	Path	The path to convert. 	-
  26 relative_to		The base path for the relative path. 	(./)
  27 .TE
  28 .SH RETURN
  29 A relative path from the reference point to the given path.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (./path/to/file.txt).relative_to((./path)) == (./to/file.txt)
  34 assert (/tmp/foo).relative_to((/tmp)) == (./foo)
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)