Possible bug in Internal Python API
Greg Ward
greg-hg at gerg.ca
Fri Aug 13 08:33:02 CDT 2010
On Fri, Aug 13, 2010 at 7:21 AM, Miguel Araujo <muchochini at gmail.com> wrote:
> I'm not going to lie. This is the first time I use it, and I think the API
> documentation at http://mercurial.selenic.com/wiki/MercurialApi is quite
> poor. I read it all and there are a lot of things not explained, the
> internal methods of many modules don't even have doc strings, so it forces
> you to read the code.
Mercurial is an open source project. It's up to *everyone* to make it better.
And you don't need to be able to devour revlogs raw before breakfast to make
it better. If you find a key API method is undocumented, then write a
docstring
and send a patch. If your docstring is good, the patch will be
accepted; if not,
it's quite likely that someone will point out what you missed. End result:
Mercurial gets better *and* you learn something. As does everyone who follows
that thread on the mailing list, or finds it in the archive in 2 years.
Also, all you have to do to improve the wiki is create a username for
yourself and
get editing. The MercurialApi page could definitely use some more
explicit tips,
suggestions, friendly advice, high-level guidelines, etc.
Greg
More information about the Mercurial-devel
mailing list