Translating Jargon

[Martin Geisler]

Isaac Jurado <diptongo at gmail.com> writes:

> There's another question open.  I've noticed that some internal
> docstrings are present in the message catalogs.  Does it make sense to
> translate them too?  How to recognise `internal' docstrings (for
> developers) from `external' ones (the ones used for help messages).

At the moment there is no good way to distinguish :-(

The problem is that we use pygettext to extract all docstrings from
these files:

  mercurial/commands.py
  hgext/*.py
  hgext/*/__init__.py

As you have found out, some extension authors has been good enough to
document their internal functions with docstrings! :-)

I think the easiest solution would be to turn the docstrings into normal
comments. The WritingExtensions page should also be updated. I will be
happy to do this, if people agree?

If anybody needs the docstrings for automatically generating API
documentation or something like that, then we can discuss how to extract
the strings more carefully.

-- 
Martin Geisler

VIFF (Virtual Ideal Functionality Framework) brings easy and efficient
SMPC (Secure Multiparty Computation) to Python. See: http://viff.dk/.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 196 bytes
Desc: not available
Url : http://selenic.com/pipermail/mercurial-devel/attachments/20090208/aa79a9b6/attachment.pgp