[CalendarServer-changes] [9126] CalendarServer/trunk/calendarserver/tools/shell/cmd.py

[source_changes at macosforge.org]

Revision: 9126
          http://trac.macosforge.org/projects/calendarserver/changeset/9126
Author:   wsanchez at apple.com
Date:     2012-04-16 14:10:56 -0700 (Mon, 16 Apr 2012)
Log Message:
-----------
docs

Modified Paths:
--------------
    CalendarServer/trunk/calendarserver/tools/shell/cmd.py

Modified: CalendarServer/trunk/calendarserver/tools/shell/cmd.py
===================================================================
--- CalendarServer/trunk/calendarserver/tools/shell/cmd.py	2012-04-16 21:02:17 UTC (rev 9125)
+++ CalendarServer/trunk/calendarserver/tools/shell/cmd.py	2012-04-16 21:10:56 UTC (rev 9126)
@@ -71,6 +71,11 @@
     #
 
     def getTarget(self, tokens):
+        """
+        Pop's the first token from tokens and locates the File
+        indicated by that token.
+        @return: a C{File}.
+        """
         if tokens:
             return self.wd.locate(tokens.pop(0).split("/"))
         else:
@@ -80,7 +85,7 @@
     def getTargets(self, tokens):
         """
         For each given C{token}, locate a File to operate on.
-        @return: iterable of File objects.
+        @return: iterable of C{File} objects.
         """
         if tokens:
             result = []
@@ -478,7 +483,7 @@
     @inlineCallbacks
     def cmd_print_principal(self, tokens):
         """
-        Print information about a principal
+        Print information about a principal.
 
         usage: print_principal uid
         """
@@ -508,6 +513,11 @@
 
     @inlineCallbacks
     def cmd_purge_principals(self, tokens):
+        """
+        Purge data associated principals.
+
+        usage: purge_principals uid [uid ...]
+        """
         dryRun     = True
         completely = False
         doimplicit = True
@@ -654,6 +664,8 @@
     def cmd_raise(self, tokens):
         """
         Raises an exception.
+
+        usage: raise
         """
         raise RuntimeError(" ".join(tokens))
 
@@ -662,6 +674,8 @@
     def cmd_reload(self, tokens):
         """
         Reloads code.
+
+        usage: reload
         """
         if tokens:
             raise UnknownArguments(tokens)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20120416/69d17b2e/attachment.html>