Commits

Mikhail Korobov  committed 94e486e

minor doc fixes

  • Participants
  • Parent commits 4be6dc5

Comments (0)

Files changed (3)

File docs/CHANGES.rst

 ---
 
 - ``verify_exists`` argument of ``fab_deploy.utils.upload_config_template``
-  function was renamed to ``skip_unexistent``; it now also passes all extra
-  kwargs directly to fabric's ``upload_template``.
+  function was renamed to ``skip_unexistent``;
+- ``fab_deploy.utils.upload_config_template`` now passes all extra
+  kwargs directly to fabric's ``upload_template`` (thanks Vladimir Mihailenco);
 - ``fab_deploy.virtualenv.pip_setup_conf`` command for uploading pip.conf
   (thanks Vladimir Mihailenco);
 - ``fab_deploy.deploy.push`` no longer calls 'synccompress' management command;
 - ``fab_deploy.deploy.push`` accepts 'before_restart' keyword argument -
   that's a callable that will be executed just before code reload;
 - fixed regression in ``fab_deploy.deploy.push`` command: 'notest' argument
-  was incorrectly renamed to 'test'.
+  was incorrectly renamed to 'test';
+- customization docs are added.
 
 0.6 (2011-03-11)
 ----------------

File docs/fabfile.rst

 
 .. autofunction:: fab_deploy.utils.inside_project
 
+.. autofunction:: fab_deploy.utils.inside_src
+
 .. autofunction:: fab_deploy.utils.run_as

File fab_deploy/utils.py

 
 def inside_src(func):
     """
-    Decorator. Use it to perform actions inside source dir with
-    virtualenv activated.
+    Decorator. Use it to perform actions inside remote source dir
+    (repository root) with virtualenv activated.
     """
     @wraps(func)
     def inner(*args, **kwargs):
 
 def inside_project(func):
     """
-    Decorator. Use it to perform actions inside project dir with
+    Decorator. Use it to perform actions inside remote project dir
+    (that's a folder where :file:`manage.py` resides) with
     virtualenv activated::
 
         from fabric.api import *