( )⚙ D4881 filectx: correct docstring about "changeid"

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4881

filectx: correct docstring about "changeid"
ClosedPublic

Authored by martinvonz on Oct 4 2018, 1:44 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGb6c2543e1dd8: filectx: correct docstring about "changeid"
rHGb13a080101e9: filectx: correct docstring about "changeid"
Summary

The changeid argument must be a revnum (basefile.rev() is defined as
"return self._changeid"), so fix the lie in the docstring. It seems to
have been incorrect for at least 10 years (I didn't check further
back).

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

martinvonz created this revision.Oct 4 2018, 1:44 PM
Closed by commit rHGb13a080101e9: filectx: correct docstring about "changeid" (authored by martinvonz). · Explain WhyOct 5 2018, 7:45 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/context.py (2 lines)

Diff 11679

mercurial/context.py

""" """
return self._repo.wwritedata(self.path(), self.data()) return self._repo.wwritedata(self.path(), self.data())
class filectx(basefilectx): class filectx(basefilectx):
"""A filecontext object makes access to data related to a particular """A filecontext object makes access to data related to a particular
filerevision convenient.""" filerevision convenient."""
def __init__(self, repo, path, changeid=None, fileid=None, def __init__(self, repo, path, changeid=None, fileid=None,
filelog=None, changectx=None): filelog=None, changectx=None):
"""changeid can be a changeset revision, node, or tag. """changeid must be a revision number, if specified.
fileid can be a file revision or node.""" fileid can be a file revision or node."""
self._repo = repo self._repo = repo
self._path = path self._path = path
assert (changeid is not None assert (changeid is not None
or fileid is not None or fileid is not None
or changectx is not None), \ or changectx is not None), \
("bad args: changeid=%r, fileid=%r, changectx=%r" ("bad args: changeid=%r, fileid=%r, changectx=%r"