[climacs-devel] Commands and documentation

John Q Splittist splittist at yahoo.com
Tue Aug 9 07:57:47 UTC 2005


Folks,

In adding a bunch of little commands it strikes me that, in the presence
of prefix arguments, it is not always obvious how a particular command
might have been implemented. To take an example, C-k seems to act subtly
differently under various editors.

We all know documentation will have to be added eventually, but I'm
thinking now, when we're actually writing the commands, would be the
time to at least add a few docstrings that might form the basis of the
'self-documenting' part of the emacsness of climacs.

There is no need to actually do anything with the docstrings at the
moment, but do people have any ideas as to a natural and flexible way to
set things out? The DEFINE-NAMED-COMMAND macro seems as good a place as
any, but while we're fiddling with that, should we also be thinking
about a natural way to express a desire to add a command to a particular
command table?

JQS

PS. I know the stuff I've added recently needs refactoring, not least to
make the functionality in various commands available to other
function/command writers.



More information about the climacs-devel mailing list