Tips and templates for writing
Template for writing docs for an API function.
- Copy and paste into appropriate enclosing doc (probably api.rst)
- Complete each todo
- Make sure all todos have been removed before pushing
Anchor link: function name with leading underscore
Function name heading
name :: (a -> b) -> Stream a -> Stream b
Short description of what it does. Usually just 1-3 sentences, but may be multiple paragraphs if needed.:
.. todo:: Ascii diagram. For example:
stream: -a-b-c-d-> map(f, stream): -f(a)-f(b)-f(c)-f(d)->
Optionally add a longer explanation, or delete if not necessary.
Add more explanation only if necessary. Otherwise, just delete this.
map(x => x + 1, stream)