Forum OpenACS Q&A: API-DOC Niggle

Collapse
Posted by defunct defunct on
Hi All,

Just thought I'd mention the current (and somewhat declining) state of
documentation tht forms the API docs.

The standard of the comments/description appearing here has never been
as good as it might, but also new functions that are appearing seem to
be letting this slip also.

There are some functions that are nothing more than a simple line
stating the obvious (which you could have guessed from the function
name) with no mention of parameters, return values.. anything.

The API browser is a really useful section, but there's little value
if all it is reduced to is displaying the source. I could look in the
file for that.

I'm not hopping up and down or banging a big drum over this ;), but
Iwould like to ask people creating/editing functions to add at least
some useful detail in the comments section. Its a really easy way of
almost self-documenting the system

Thanks