File: isDirectory-doc.m2

package info (click to toggle)
macaulay2 1.17.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 68,376 kB
  • sloc: cpp: 102,995; ansic: 10,040; javascript: 6,019; sh: 3,506; makefile: 3,426; lisp: 727; yacc: 590; perl: 369; xml: 177; python: 141; lex: 65; awk: 3
file content (19 lines) | stat: -rw-r--r-- 513 bytes parent folder | download | duplicates (4) 
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}
     }