# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@ens-lyon.org>
# Date 1491754569 -7200
# Node ID 6d055cd6669f771e815cc11dd9d8522f6ef3ba73
# Parent  56f58027a513470a623204f1b0a04ce34c1973c5
bundle2: add documention to 'part.addparams'

There are some non-obvious limitations on the parameters of this method.
Add some documentation where people will likely look to understand how
to use this API.

diff -r 56f58027a513 -r 6d055cd6669f mercurial/bundle2.py
--- a/mercurial/bundle2.py	Mon Apr 10 21:12:54 2017 -0400
+++ b/mercurial/bundle2.py	Sun Apr 09 18:16:09 2017 +0200
@@ -900,6 +900,13 @@
         return tuple(self._advisoryparams)
 
     def addparam(self, name, value='', mandatory=True):
+        """add a parameter to the part
+
+        If 'mandatory' is set to True, the remote handler must claim support
+        for this parameter or the unbundling will be aborted.
+
+        The 'name' and 'value' cannot exceed 255 bytes each.
+        """
         if self._generated is not None:
             raise error.ReadOnlyPartError('part is being generated')
         if name in self._seenparams: