D1440: docs: add args/returns docs for some cmdutil, context, and registrar functions

lothiraldan (Boris Feld) phabricator at mercurial-scm.org
Fri Nov 17 02:58:12 EST 2017


lothiraldan requested changes to this revision.
lothiraldan added a comment.
This revision now requires changes to proceed.


  Looking good, just need a bunch of fixes. Also, did you tried generating the documentation, I'm not sure how 'parameters' would render in the documentation.

INLINE COMMENTS

> context.py:637
> +
> +        Children are the immediate changesets of the current changeset.
> +        Use decendents() to recursively walk children.

I think there is a mistake here, `immediate changesets of the current changeset`.

> context.py:638
> +        Children are the immediate changesets of the current changeset.
> +        Use decendents() to recursively walk children.
> +        """

s/decendents/descendants

> registrar.py:132
>  
>      The optionalrepo argument defines whether the command optionally requires
> +    a local repository. If no repository can be found, None will be passed

Should optionalrepo also be highlighted? ``optionalrepo``

> registrar.py:136
>  
>      The inferrepo argument defines whether to try to find a repository from the
>      command line arguments. If True, arguments will be examined for potential

Should inferrepo also be highlighted? ``inferrepo``

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D1440

To: rlevasseur, #hg-reviewers, lothiraldan
Cc: lothiraldan, mercurial-devel


More information about the Mercurial-devel mailing list