# HG changeset patch # User Gregory Szorc # Date 2018-01-30 23:21:59 # Node ID b4976912a6ef0acb291f4cd57fde4354df1761a9 # Parent ae79cf6f9c82ad7df592030899c579eb913dfc49 wireproto: improve docstring for @wireprotocommand I'm about to add more arguments and want them to be documented. Plus, good documentation is nice to have. Differential Revision: https://phab.mercurial-scm.org/D1997 diff --git a/mercurial/wireproto.py b/mercurial/wireproto.py --- a/mercurial/wireproto.py +++ b/mercurial/wireproto.py @@ -638,7 +638,13 @@ def supportedcompengines(ui, proto, role 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