D2217: wireproto: improve docstring for "hello"
indygreg (Gregory Szorc)
phabricator at mercurial-scm.org
Tue Feb 13 03:48:50 UTC 2018
indygreg created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.
REPOSITORY
rHG Mercurial
REVISION DETAIL
https://phab.mercurial-scm.org/D2217
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
@@ -901,13 +901,16 @@
@wireprotocommand('hello')
def hello(repo, proto):
- '''the hello command returns a set of lines describing various
- interesting things about the server, in an RFC822-like format.
- Currently the only one defined is "capabilities", which
- consists of a line in the form:
+ """Called as part of SSH handshake to obtain server info.
+
+ Returns a list of lines describing interesting things about the
+ server, in an RFC822-like format.
- capabilities: space separated list of tokens
- '''
+ Currently, the only one defined is ``capabilities``, which consists of a
+ line of space separated tokens describing server abilities:
+
+ capabilities: <token0> <token1> <token2>
+ """
caps = capabilities(repo, proto).data
return bytesresponse('capabilities: %s\n' % caps)
To: indygreg, #hg-reviewers
Cc: mercurial-devel
More information about the Mercurial-devel
mailing list