D1340: dirstate: add explicit methods for modifying dirstate

durin42 (Augie Fackler) phabricator at mercurial-scm.org
Fri Nov 10 17:06:53 EST 2017

durin42 requested changes to this revision.
durin42 added inline comments.
This revision now requires changes to proceed.


> dirstate.py:130
>      def _map(self):
> -        '''Return the dirstate contents as a map from filename to
> -        (state, mode, size, time).'''
> +        '''Returns the dirstate map.'''
>          self._map = dirstatemap(self._ui, self._opener, self._root)

Why is ~all the interesting content of this docstring removed? Where is the meaning of the dirstate map documented other than this docstring?

> dirstate.py:1196
>  class dirstatemap(object):
>      def __init__(self, ui, opener, root):

Per my comment above, let's insert a patch before this one that documents in more detail the API that dirstatemap is supposed to be providing, probably in a docstring on this class. Sound reasonable?

(Then the above docstring I complained about could point to this docstring.)

  rHG Mercurial


To: mbthomas, #hg-reviewers, durin42
Cc: durin42, mbolin, mercurial-devel

More information about the Mercurial-devel mailing list