code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.subdirectories 3 2026-03-14 "Tomo man-pages"
   6 .SH NAME
   7 Path.subdirectories \- get subdirectories
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.subdirectories\ :\ func(path:\ Path,\ include_hidden\ =\ no\ ->\ [Path])
  13 .fi
  14 .SH DESCRIPTION
  15 Returns a list of subdirectories within the directory at the specified path. Optionally includes hidden subdirectories.
  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 of the directory. 	-
  26 include_hidden		Whether to include hidden subdirectories (those starting with a \fB.\fR) 	no
  27 .TE
  28 .SH RETURN
  29 A list of subdirectory paths.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (./directory).subdirectories() == [(./directory/subdir1), (./directory/subdir2)]
  34 assert (./directory).subdirectories(include_hidden=yes) == [(./directory/.git), (./directory/subdir1), (./directory/subdir2)]
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)