# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 1399254304 25200
# Node ID a039e1f2326f131e743f50492bb089e9b1140bb1
# Parent  44255f7ce886c0c4efc59ba8aea15e57ddc23f4c
cmdutil: better document command()

diff -r 44255f7ce886 -r a039e1f2326f mercurial/cmdutil.py
--- a/mercurial/cmdutil.py	Wed Jun 11 22:19:29 2014 -0400
+++ b/mercurial/cmdutil.py	Sun May 04 18:45:04 2014 -0700
@@ -2473,8 +2473,23 @@
             repo.dirstate.copy(copied[f], f)
 
 def command(table):
-    '''returns a function object bound to table which can be used as
-    a decorator for populating table as a command table'''
+    """Returns a function object to be used as a decorator for making commands.
+
+    This function receives a command table as its argument. The table should
+    be a dict.
+
+    The returned function can be used as a decorator for adding commands
+    to that command table. This function accepts multiple arguments to define
+    a command.
+
+    The first argument is the command name.
+
+    The options argument is an iterable of tuples defining command arguments.
+    See ``mercurial.fancyopts.fancyopts()`` for the format of each tuple.
+
+    The synopsis argument defines a short, one line summary of how to use the
+    command. This shows up in the help output.
+    """
 
     def cmd(name, options=(), synopsis=None):
         def decorator(func):