Commits

Mikhail Korobov committed 4373e77

Improved docstrings for a couple of commands

Comments (0)

Files changed (1)

fab_deploy/django_commands.py

 
 @inside_project
 def manage(command):
-    """ Runs django management command. """
+    """ Runs django management command.
+    Example::
+
+        fab manage:createsuperuser
+    """
     run('python ./manage.py '+ command)
 
 def migrate(params='', do_backup=True):
 
 @inside_project
 def test(what=''):
-    """ Runs 'runtests.sh' script from project root. """
+    """ Runs 'runtests.sh' script from project root.
+    Example runtests.sh content::
+
+        #!/bin/sh
+
+        default_tests='accounts forum firms blog'
+        if [ $# -eq 0 ]
+        then
+            ./manage.py test $default_tests --settings=test_settings
+        else
+            ./manage.py test $* --settings=test_settings
+        fi
+    """
     with settings(warn_only=True):
         run('./runtests.sh ' + what)
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.