File: isDirectory-doc.m2

package info (click to toggle)
macaulay2 1.25.05%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 172,152 kB
  • sloc: cpp: 107,824; ansic: 16,193; javascript: 4,189; makefile: 3,899; lisp: 702; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (19 lines) | stat: -rw-r--r-- 513 bytes parent folder | download | duplicates (5) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => isDirectory,
     Headline => "whether a file is a directory",
     Usage => "isDirectory fn",
     Inputs => { "fn" => String => "a filename or path" },
     Outputs => { Boolean => { "whether ", TT "fn", " is the path to a directory" }},
     EXAMPLE lines ///
     	  isDirectory "."
     	  fn = temporaryFileName()
	  fn << "hi there" << close
	  isDirectory fn
	  removeFile fn
     ///,
     SeeAlso => {isRegularFile, readlink}
     }