Następny: Comment Tips, Poprzedni: Coding Tips, W górę: Tips
Here are some tips for the writing of documentation strings.
The documentation string can have additional lines that expand on the details of how to use the function or variable. The additional lines should also be made up of complete sentences.
However, rather than simply filling the entire documentation string, you can make it much more readable by choosing line breaks with care. Use blank lines between topics if the documentation string is long.
/
refers to its second argument as `DIVISOR', because the
actual argument name is divisor
.
Also use all caps for meta-syntactic variables, such as when you show the decomposition of a list or vector into subunits, some of which may vary.