Document changeDirectory

Macaulay2 · May 30, 2024 · f73b8e0 · f73b8e0
1 parent 19c78dc
commit f73b8e0
Showing 1 changed file with 30 additions and 1 deletion.
diff --git a/M2/Macaulay2/packages/Macaulay2Doc/system.m2 b/M2/Macaulay2/packages/Macaulay2Doc/system.m2
@@ -644,8 +644,37 @@ document {
      ///,
      PARA {
 	  "If a component of the path to the current directory no longer exist, an error will be signalled."
-	  }
+	  },
+     SeeAlso => {changeDirectory}
      }
+
+doc ///
+  Key
+    changeDirectory
+  Headline
+    change the current working directory
+  Usage
+    changeDirectory dir
+  Inputs
+    dir:String
+  Description
+    Text
+      Change the current working directory to @VAR "dir"@.
+    Example
+      dir = temporaryFileName()
+      makeDirectory dir
+      changeDirectory dir
+      currentDirectory()
+    Text
+      If @VAR "dir"@ is omitted, then the current working directory
+      is changed to the user's home directory.
+    Example
+      changeDirectory()
+      currentDirectory()
+  SeeAlso
+    currentDirectory
+///
+
 document {
      Key => exec,
      Headline => "execute another program",