Hi all,

I've discovered recently checkdoc (M-x checkdoc in an elisp buffer).
This checks that the docstrings and messages of the buffer matches the
Emacs coding standard.

I've started applying this to xtla (see the bugtracker). xtla-tips.el
and xtla-test.el now pass the check. For xtla.el, I've spent some time
on it, but so far, I've only done 30% of the buffer.

The result is rather interesting. Many functions were simply
undocumented, but I've learnt a lot on the way to write docstrings.

I encourrage you to try it and use it for your next contributions to
xtla (optionally, I'd appreciate some help to document the existing
code :-). Just trying it and fixing a few messages will teach you a
lot.

-- 
Matthieu

Reply via email to