( )⚙ D5466 repository: update interface signature of narrowmatch()

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5466

repository: update interface signature of narrowmatch()
ClosedPublic

Authored by martinvonz on Dec 20 2018, 1:11 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGb2de94e59702: repository: update interface signature of narrowmatch()
rHG6d49a573ba57: repository: update interface signature of narrowmatch()
Summary

This should have been part of 4fd0fac48922 (localrepo: allow
narrowmatch() to accept matcher to intersect with, 2018-09-28) and
41fcdfe3bfeb (narrow: allow repo.narrowmatch(match) to include exact
matches from "match", 2018-10-01).

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

martinvonz created this revision.Dec 20 2018, 1:11 PM
pulkit added a subscriber: pulkit.Dec 20 2018, 1:35 PM
pulkit added inline comments.
mercurial/repository.py
1480

Maybe add docs about what these arguments are.

martinvonz added inline comments.Dec 20 2018, 1:39 PM
mercurial/repository.py
1480

That documentation is already in localrepo.py. Is the idea to keep the same documentation in both places? I'm not objecting, just trying to understand how to handle this.

pulkit added a subscriber: indygreg.Dec 20 2018, 2:03 PM
pulkit accepted this revision.
pulkit added inline comments.
mercurial/repository.py
1480

Ah, my bad. I am also not sure which one is better place to document. Maybe @indygreg will have ideas.

Closed by commit rHG6d49a573ba57: repository: update interface signature of narrowmatch() (authored by martinvonz). · Explain WhyDec 20 2018, 2:17 PM
This revision was automatically updated to reflect the committed changes.
indygreg added a comment.Dec 20 2018, 6:23 PM

I'd say `repository.py is the best place for docs, since localrepo.py` implements the interface and the interface is what matters.

Revision Contents
Changeset List

PathPackages
Mmercurial/repository.py (2 lines)

Diff 12930

mercurial/repository.py

""") """)
dirstate = interfaceutil.Attribute( dirstate = interfaceutil.Attribute(
"""Working directory state.""") """Working directory state.""")
narrowpats = interfaceutil.Attribute( narrowpats = interfaceutil.Attribute(
"""Matcher patterns for this repository's narrowspec.""") """Matcher patterns for this repository's narrowspec.""")
def narrowmatch(): def narrowmatch(match=None, includeexact=False):
pulkitUnsubmitted
Not Done

Maybe add docs about what these arguments are.

pulkit: Maybe add docs about what these arguments are.
martinvonzAuthorUnsubmitted
Not Done

That documentation is already in localrepo.py. Is the idea to keep the same documentation in both places? I'm not objecting, just trying to understand how to handle this.

martinvonz: That documentation is already in `localrepo.py`. Is the idea to keep the same documentation in…
pulkitUnsubmitted
Not Done

Ah, my bad. I am also not sure which one is better place to document. Maybe @indygreg will have ideas.

pulkit: Ah, my bad. I am also not sure which one is better place to document. Maybe @indygreg will have…
"""Obtain a matcher for the narrowspec.""" """Obtain a matcher for the narrowspec."""
def setnarrowpats(newincludes, newexcludes): def setnarrowpats(newincludes, newexcludes):
"""Define the narrowspec for this repository.""" """Define the narrowspec for this repository."""
def __getitem__(changeid): def __getitem__(changeid):
"""Try to resolve a changectx.""" """Try to resolve a changectx."""