[PATCH] hideablerevs: expand docstring to warn about possible traps

[timeless]

lgtm

On Mon, Apr 4, 2016 at 5:18 PM, Martijn Pieters <mj at zopatista.com> wrote:
> On 4 April 2016 at 09:31, Pierre-Yves David
> <pierre-yves.david at ens-lyon.org> wrote:
>        """Revisions candidates to be hidden
>
>> +    This is a standalone function to help extensions to wrap it.
>> +
>> +    Because we use the set of immutable changeset as a fallback subset in
>> +    branchmap (see mercurial.branchmap.subsettable), You cannot set "public"
>> +    changesets as "hideable". Doing so would break multiple code assertions and
>> +    lead to crashs."""
>
> Edited for spelling / grammar:
>
> """
> Revision candidates to be hidden
>
> This is a standalone function to allow extensions to wrap it.
>
> Because we use the set of immutable changesets as a fallback subset in
> branchmap (see mercurial.branchmap.subsettable), you cannot set "public"
> changesets as "hideable". Doing so would break multiple code assertions and
> lead to crashes.
>
> """
>
> --
> Martijn Pieters
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel at mercurial-scm.org
> https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel