[Python-checkins] cpython (3.4): Fix parameter name in docs for os.makedirs and os.removedirs.

Thu Mar 20 18:00:03 CET 2014

http://hg.python.org/cpython/rev/8d53d3f61b0c
changeset: 89881:8d53d3f61b0c
branch: 3.4
parent: 89879:3cdb5ceb30d1
user: Zachary Ware <zachary.ware at gmail.com>
date: Thu Mar 20 09:42:01 2014 -0500
summary:
 Fix parameter name in docs for os.makedirs and os.removedirs.
Pointed out by Colin Davis on docs at .
files:
 Doc/library/os.rst | 4 ++--
 Lib/os.py | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1607,7 +1607,7 @@
 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 @@
 The *dir_fd* argument.
 
 
-.. function:: removedirs(path)
+.. function:: removedirs(name)
 
 .. index:: single: directory; deleting
 
diff --git a/Lib/os.py b/Lib/os.py
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -216,7 +216,7 @@
 # (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 @@
 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
-- 
Repository URL: http://hg.python.org/cpython
