D1440: docs: add args/returns docs for some cmdutil, context, and registrar functions
rlevasseur (Richard Levasseur)
phabricator at mercurial-scm.org
Sat Nov 18 16:14:42 EST 2017
rlevasseur added a comment.
In https://phab.mercurial-scm.org/D1440#23968, @pulkit wrote:
> I see you used the word `string` at few places, do you mean the Python string? If yes, that won't be true on Python 3 as most of the things are bytes.
Ah good to know. I don't have much non-ascii stuff, so didn't notice. Ascii only unicode strings work OK -- if thats intentional/desired/supported, it should probably be doc'd as something like "bytes or ascii-encodable string" so callers don't think they have to use b'foo' or 'foo'.encode() everywhere. I've changed it to "bytes" for now -- let me know if you want "bytes or ascii-encodable string" (or equiv).
In https://phab.mercurial-scm.org/D1440#23956, @lothiraldan wrote:
> Also, did you tried generating the documentation, I'm not sure how 'parameters' would render in the documentation.
I ran make doc, but didn't see it output generated docs based on the code itself. Is there a command I missed? I was just assuming the format is RST for the doc strings, since that seems to be the popular format these days.
To: rlevasseur, #hg-reviewers, lothiraldan
Cc: pulkit, lothiraldan, mercurial-devel
More information about the Mercurial-devel