To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Heritage persistent IDentifiers (SWHIDs) must be used instead of copying and pasting the url from the address bar of the browser (as there is no guarantee the current URI scheme will remain the same over time).
Select below a type of object currently browsed in order to display its associated SWHID and permalink.
Add nose as a dependency
.. _documentation: Documentation ============= Documentation is a crutial part of this library. All functions and classes should come with useful docstrings. For these, we use the numpy style docstrings. For instance, for a function, we expect the following docstring: .. code:: python def function(arg): """One line description Longer description Parameters ---------- arg : type description Returns ------- variable : type description Examples -------- text >>> code expected result Notes ----- Detailed explanation """ pass In particular, use single backticks for variable's names: `\`variable\``. Double backticks are used for inline code: ````inline code````. For blocks of code, use double colons, leave a white line and indent said lines of code .. code:: rst :: block of code on several lines...