Patchwork D1997: wireproto: improve docstring for @wireprotocommand

login
register
mail settings
Submitter phabricator
Date Feb. 7, 2018, 10:41 p.m.
Message ID <aa417056fd7b1abf59541fd4ea5331a2@localhost.localdomain>
Download mbox | patch
Permalink /patch/27438/
State Not Applicable
Headers show

Comments

phabricator - Feb. 7, 2018, 10:41 p.m.
This revision was automatically updated to reflect the committed changes.
Closed by commit rHGb4976912a6ef: wireproto: improve docstring for @wireprotocommand (authored by indygreg, committed by ).

REPOSITORY
  rHG Mercurial

CHANGES SINCE LAST UPDATE
  https://phab.mercurial-scm.org/D1997?vs=5136&id=5306

REVISION DETAIL
  https://phab.mercurial-scm.org/D1997

AFFECTED FILES
  mercurial/wireproto.py

CHANGE DETAILS




To: indygreg, #hg-reviewers, durin42
Cc: mercurial-devel

Patch

diff --git a/mercurial/wireproto.py b/mercurial/wireproto.py
--- a/mercurial/wireproto.py
+++ b/mercurial/wireproto.py
@@ -638,7 +638,13 @@ 
 commands = {}
 
 def wireprotocommand(name, args=''):
-    """decorator for wire protocol command"""
+    """Decorator to declare a wire protocol command.
+
+    ``name`` is the name of the wire protocol command being provided.
+
+    ``args`` is a space-delimited list of named arguments that the command
+    accepts. ``*`` is a special value that says to accept all arguments.
+    """
     def register(func):
         commands[name] = (func, args)
         return func