Add doc for compileall.compile_file
diff --git a/Lib/compileall.py b/Lib/compileall.py
index f564abb..910f305 100644
--- a/Lib/compileall.py
+++ b/Lib/compileall.py
@@ -9,7 +9,6 @@
packages -- for now, you'll have to deal with packages separately.)
See module py_compile for details of the actual byte-compilation.
-
"""
import os
import sys
@@ -31,7 +30,6 @@
directory name that will show up in error messages)
force: if 1, force compilation, even if timestamps are up-to-date
quiet: if 1, be quiet during compilation
-
"""
if not quiet:
print 'Listing', dir, '...'
@@ -61,15 +59,16 @@
return success
def compile_file(fullname, ddir=None, force=0, rx=None, quiet=0):
- """Byte-compile file.
- file: the file to byte-compile
+ """Byte-compile one file.
+
+ Arguments (only fullname is required):
+
+ fullname: the file to byte-compile
ddir: if given, purported directory name (this is the
directory name that will show up in error messages)
force: if 1, force compilation, even if timestamps are up-to-date
quiet: if 1, be quiet during compilation
-
"""
-
success = 1
name = os.path.basename(fullname)
if ddir is not None:
@@ -120,7 +119,6 @@
maxlevels: max recursion level (default 0)
force: as for compile_dir() (default 0)
quiet: as for compile_dir() (default 0)
-
"""
success = 1
for dir in sys.path: