File: removeDirectory-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 (18 lines) | stat: -rw-r--r-- 482 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => removeDirectory,
     Headline => "remove a directory",
     Usage => "removeDirectory dir",
     Inputs => { "dir" => String => "a filename or path to a directory" },
     Consequences => { "the directory is removed" },     
     EXAMPLE lines ///
     	  dir = temporaryFileName()
	  makeDirectory dir
	  readDirectory dir
	  removeDirectory dir
     ///,
     SeeAlso => {readDirectory, makeDirectory}
     }