diff options
| author | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-08 23:51:23 -0700 |
|---|---|---|
| committer | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-08 23:51:23 -0700 |
| commit | 4378349f77f3dfd2c94244c6a2f427babd17c9d4 (patch) | |
| tree | bba3f0d4a8a0277794c4b25c9483fd155f2d5981 /docs | |
| parent | 90b15a391b5ed69f64cd4ffbf154e3e41bb241cb (diff) | |
| download | xnt-4378349f77f3dfd2c94244c6a2f427babd17c9d4.tar.gz xnt-4378349f77f3dfd2c94244c6a2f427babd17c9d4.tar.xz | |
Update Task Reference Docs
After pylinting, some of these definitions were a bit out of date.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/taskreference.rst | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/docs/source/taskreference.rst b/docs/source/taskreference.rst index d55f387..a65f00e 100644 --- a/docs/source/taskreference.rst +++ b/docs/source/taskreference.rst @@ -26,19 +26,19 @@ File Tasks Return a generator for glob expansion of *path* .. _xnt.tasks.cp: -.. function:: cp(src="",dst="",files=[]) +.. function:: cp(src="", dst="", files=None) Copy the source file or directory (*src*) OR files/folders (*files*) to destination file or directory (*dst*) .. _xnt.tasks.mv: -.. function:: mv(src,dst) +.. function:: mv(src, dst) Move the source file or directory (*src*) to destination file or directory (*dst*) .. _xnt.tasks.mkdir: -.. function:: mkdir(dir,mode=0o777) +.. function:: mkdir(dir, mode=0o777) Create a directory specified by *dir* with default mode (where supported) or with the specified mode @@ -56,11 +56,10 @@ File Tasks Archive Tasks ============= -.. _xnt.tasks.zip: -.. function:: zip(dir,zipfilename) +.. _xnt.tasks.create_zip: +.. function:: create_zip(directory, zipfilename) - Zip the specified directory (*dir*) into the zip file specified by - *zipfilename* + Zip the specified *directory* into the zip file specified by *zipfilename* Miscellaneous Tasks =================== @@ -104,10 +103,10 @@ Compile Tasks ============= .. _xnt.tasks.setup: -.. function:: setup(commands, dir="") +.. function:: setup(commands, directory="") Invoke Python setup.py given the list of *commands* (or options) in the - current directory or in a different directory, specified by *dir*. + current directory or in a different directory, specified by *directory*. SCM Tasks ========= |