# HG changeset patch
# User Augie Fackler <augie@google.com>
# Date 2016-03-02 19:18:43
# Node ID 176736afa886df249450d20faff9798ec1e00119
# Parent  d549cbb5503d483c4f60a50dc47bc173a1720e30

wireproto: document quirk of _callstream between http and ssh

This tripped me up when trying to use it, so it feels like we should
document this to avoid future pain.

diff --git a/mercurial/wireproto.py b/mercurial/wireproto.py
--- a/mercurial/wireproto.py
+++ b/mercurial/wireproto.py
@@ -396,9 +396,12 @@ class wirepeer(peer.peerrepository):
     def _callstream(self, cmd, **args):
         """execute <cmd> on the server
 
-        The command is expected to return a stream.
+        The command is expected to return a stream. Note that if the
+        command doesn't return a stream, _callstream behaves
+        differently for ssh and http peers.
 
-        returns the server reply as a file like object."""
+        returns the server reply as a file like object.
+        """
         raise NotImplementedError()
 
     def _callcompressable(self, cmd, **args):