]> granicus.if.org Git - python/commitdiff
Fix parameter name in docs for os.makedirs and os.removedirs.
authorZachary Ware <zachary.ware@gmail.com>
Thu, 20 Mar 2014 14:42:01 +0000 (09:42 -0500)
committerZachary Ware <zachary.ware@gmail.com>
Thu, 20 Mar 2014 14:42:01 +0000 (09:42 -0500)
Pointed out by Colin Davis on docs@.

Doc/library/os.rst
Lib/os.py

index f50e5d97f49160940e33ab9fd66c27d39d1a1b71..8e19c25b79c8f5c9c57660e632c77eabff89b7fd 100644 (file)
@@ -1607,7 +1607,7 @@ features:
       The *dir_fd* argument.
 
 
-.. function:: makedirs(path, mode=0o777, exist_ok=False)
+.. function:: makedirs(name, mode=0o777, exist_ok=False)
 
    .. index::
       single: directory; creating
@@ -1763,7 +1763,7 @@ features:
       The *dir_fd* argument.
 
 
-.. function:: removedirs(path)
+.. function:: removedirs(name)
 
    .. index:: single: directory; deleting
 
index e9880a1e4c7af9d310c93328560057e4dbc057d6..fa0fbb9b3e5d12a716095b8c93c89d5569d10d78 100644 (file)
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -216,7 +216,7 @@ def _get_masked_mode(mode):
 # (Inspired by Eric Raymond; the doc strings are mostly his)
 
 def makedirs(name, mode=0o777, exist_ok=False):
-    """makedirs(path [, mode=0o777][, exist_ok=False])
+    """makedirs(name [, mode=0o777][, exist_ok=False])
 
     Super-mkdir; create a leaf directory and all intermediate ones.
     Works like mkdir, except that any intermediate path segment (not
@@ -260,7 +260,7 @@ def makedirs(name, mode=0o777, exist_ok=False):
             raise
 
 def removedirs(name):
-    """removedirs(path)
+    """removedirs(name)
 
     Super-rmdir; remove a leaf directory and all empty intermediate
     ones.  Works like rmdir except that, if the leaf directory is