Patchwork D2217: wireproto: improve docstring for "hello"

login
register
mail settings
Submitter phabricator
Date Feb. 13, 2018, 3:48 a.m.
Message ID <differential-rev-PHID-DREV-6kco6ktigo6r6gswq4y4-req@phab.mercurial-scm.org>
Download mbox | patch
Permalink /patch/27798/
State Superseded
Headers show

Comments

phabricator - Feb. 13, 2018, 3:48 a.m.
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




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

Patch

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)