[PATCH 2 of 4] bundle2: clarify the docstring of unpackermixin methods

[Pierre-Yves David]

# HG changeset patch
# User Pierre-Yves David <pierre-yves.david at ens-lyon.org>
# Date 1491754374 -7200
#      Sun Apr 09 18:12:54 2017 +0200
# Node ID 0ae7bb16d6ceb88bbb76859dbdf30c9f92490369
# Parent  94eac6f88d489757b183229681baf0d3f44284e7
# EXP-Topic bundle2.doc
# Available At https://www.mercurial-scm.org/repo/users/marmoute/mercurial/
#              hg pull https://www.mercurial-scm.org/repo/users/marmoute/mercurial/ -r 0ae7bb16d6ce
bundle2: clarify the docstring of unpackermixin methods

The unpackermixin is a utility used to implement the bundle2 protocol. It should
not be used when writing part handler. We update the docstring to clarify this.

diff --git a/mercurial/bundle2.py b/mercurial/bundle2.py
--- a/mercurial/bundle2.py
+++ b/mercurial/bundle2.py
@@ -621,12 +621,18 @@ class unpackermixin(object):
                           util.safehasattr(fp, 'tell'))
 
     def _unpack(self, format):
-        """unpack this struct format from the stream"""
+        """unpack this struct format from the stream
+
+        This method is meant for internal usage of bundle2 protocol only.
+        Do not use it to implement higher level"""
         data = self._readexact(struct.calcsize(format))
         return _unpack(format, data)
 
     def _readexact(self, size):
-        """read exactly <size> bytes from the stream"""
+        """read exactly <size> bytes from the stream
+
+        This method is meant for internal usage of bundle2 protocol.
+        Do not use it to implement higher level"""
         return changegroup.readexactly(self._fp, size)
 
     def seek(self, offset, whence=0):