( )⚙ D6467 doc: fix description of "predecessors" to match reality

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6467

doc: fix description of "predecessors" to match reality
ClosedPublic

Authored by joerg.sonnenberger on May 31 2019, 7:26 PM.

Details

Reviewers
av6
pulkit
Group Reviewers
hg-reviewers
Commits
rHGdc5bd66a8270: doc: fix description of "predecessors" to match reality

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

av6 added a subscriber: av6.Jun 1 2019, 3:55 AM

This change looks good, but I have doubts about "visible" in the docstring. 1858fc2327ef does say that this template keyword respects repo filtering, but I've encountered instances where it shows hidden predecessors (that need --hidden to be seen).

av6 accepted this revision.Jun 3 2019, 9:58 AM
This revision is now accepted and ready to land.Jun 3 2019, 9:58 AM
pulkit accepted this revision.Jun 10 2019, 10:41 AM
Closed by commit rHGdc5bd66a8270: doc: fix description of "predecessors" to match reality (authored by joerg.sonnenberger). · Explain WhyJun 10 2019, 10:56 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/templatekw.py (2 lines)

Diff 15315

mercurial/templatekw.py

p = paths[k] p = paths[k]
d = {'name': k, 'url': p.rawloc} d = {'name': k, 'url': p.rawloc}
d.update((o, v) for o, v in sorted(p.suboptions.iteritems())) d.update((o, v) for o, v in sorted(p.suboptions.iteritems()))
return d return d
return _hybrid(None, urls, makemap, lambda k: '%s=%s' % (k, urls[k])) return _hybrid(None, urls, makemap, lambda k: '%s=%s' % (k, urls[k]))
@templatekeyword("predecessors", requires={'repo', 'ctx'}) @templatekeyword("predecessors", requires={'repo', 'ctx'})
def showpredecessors(context, mapping): def showpredecessors(context, mapping):
"""Returns the list of the closest visible successors. (EXPERIMENTAL)""" """Returns the list of the closest visible predecessors. (EXPERIMENTAL)"""
repo = context.resource(mapping, 'repo') repo = context.resource(mapping, 'repo')
ctx = context.resource(mapping, 'ctx') ctx = context.resource(mapping, 'ctx')
predecessors = sorted(obsutil.closestpredecessors(repo, ctx.node())) predecessors = sorted(obsutil.closestpredecessors(repo, ctx.node()))
predecessors = pycompat.maplist(hex, predecessors) predecessors = pycompat.maplist(hex, predecessors)
return _hybrid(None, predecessors, return _hybrid(None, predecessors,
lambda x: {'ctx': repo[x]}, lambda x: {'ctx': repo[x]},
lambda x: scmutil.formatchangeid(repo[x])) lambda x: scmutil.formatchangeid(repo[x]))