Patchwork [1,of,4] bundle2: add documention to 'part.addparams'

login
register
mail settings
Submitter Pierre-Yves David
Date April 9, 2017, 5:41 p.m.
Message ID <94eac6f88d489757b183.1491759713@nodosa.octopoid.net>
Download mbox | patch
Permalink /patch/20038/
State Changes Requested
Headers show

Comments

Pierre-Yves David - April 9, 2017, 5:41 p.m.
# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@ens-lyon.org>
# Date 1491754569 -7200
#      Sun Apr 09 18:16:09 2017 +0200
# Node ID 94eac6f88d489757b183229681baf0d3f44284e7
# Parent  e0dc40530c5aa514feb6a09cf79ab6a3aa2ec331
# 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 94eac6f88d48
bundle2: add documention to 'part.addparams'

They are some non-obvious limitation to what the parameters can be. We make it
clearer on the method as code writter might seek details there.
Ryan McElroy - April 10, 2017, 9:17 a.m.
On 4/9/17 6:41 PM, Pierre-Yves David wrote:
> # HG changeset patch
> # User Pierre-Yves David <pierre-yves.david@ens-lyon.org>
> # Date 1491754569 -7200
> #      Sun Apr 09 18:16:09 2017 +0200
> # Node ID 94eac6f88d489757b183229681baf0d3f44284e7
> # Parent  e0dc40530c5aa514feb6a09cf79ab6a3aa2ec331
> # EXP-Topic bundle2.doc
> bundle2: add documention to 'part.addparams'
>
> They are some non-obvious limitation to what the parameters can be. We make it
s/They/There
s/limitation/limitations

> clearer on the method as code writter might seek details there.

s/writter/writer


I might actually just rewrite this to be:

# 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 --git a/mercurial/bundle2.py b/mercurial/bundle2.py
> --- a/mercurial/bundle2.py
> +++ b/mercurial/bundle2.py
> @@ -900,6 +900,13 @@ class bundlepart(object):
>           return tuple(self._advisoryparams)
>   
>       def addparam(self, name, value='', mandatory=True):
> +        """add a parameter to the part
> +
> +        If 'mandatory' is set to True, the remove handler must claim support

s/remove/remote

> +        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:
>

Patch

diff --git a/mercurial/bundle2.py b/mercurial/bundle2.py
--- a/mercurial/bundle2.py
+++ b/mercurial/bundle2.py
@@ -900,6 +900,13 @@  class bundlepart(object):
         return tuple(self._advisoryparams)
 
     def addparam(self, name, value='', mandatory=True):
+        """add a parameter to the part
+
+        If 'mandatory' is set to True, the remove 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: