Scratch pad in markdown¶
This is a scratch pad to try documenting functions. Use it as you want!
colon fences for admonitions¶
This is a note admonition using the colon fence syntax
Note
This text is standard Markdown
This is a note admonition using the standard triple-backquotes directive marker
Note
This text is standard Markdown
cross-linking¶
You can cross-link to documented parts of the API like this:
You can also cross-link to external functions, like io.open() for example
the eval-rst directive¶
Sometimes, some directives produce code that need to be further processed. But if we are
processing markdown, and our directive produces rst, then we have a problem. You can use the
eval-rst directive to make this work:
This doesn’t work:
.. py:function:: shutdown()
- module:
magpie
Shutdown all the worker processes from the task queue system.
But this does:
- magpie.shutdown()[source]
Shutdown all the worker processes from the task queue system.