D1997: wireproto: improve docstring for @wireprotocommand
indygreg (Gregory Szorc)
phabricator at mercurial-scm.org
Thu Feb 1 23:37:46 UTC 2018
indygreg created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.
REVISION SUMMARY
I'm about to add more arguments and want them to be documented.
Plus, good documentation is nice to have.
REPOSITORY
rHG Mercurial
REVISION DETAIL
https://phab.mercurial-scm.org/D1997
AFFECTED FILES
mercurial/wireproto.py
CHANGE DETAILS
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
To: indygreg, #hg-reviewers
Cc: mercurial-devel
More information about the Mercurial-devel
mailing list