good chemistry is complicated, and a little bit messy -LW |
|
PerlMonks |
comment on |
( [id://3333]=superdoc: print w/replies, xml ) | Need Help?? |
A recent gripe I've uncovered from looking at the docs of a very large application whose development team I've recently joined...
When documenting the args to a function, do not use a scalar in the place of a reference to something. It throws people (like me) off. =item $obj->add_kids($kids) should be =item $obj->add_kids(\@kids) And the function's name should represent the ability to take more than one child. If it were named add_kid, I'd go nuts. Honestly.
_____________________________________________________ In reply to Re: Writing Good Documentation
by japhy
|
|