Standardize docstrings #50
Description
we should probably standardize our docstrings
I have been using numpydoc style, which looks like this:
Parameters
----------
x : type
Description of parameter `x`.
y
Description of parameter `y` (with type not specified)
but I noticed @chrisjsewell has been using a different style (not sure exactly which, but it looks like the following)
:param text: the file text
:param code_directive: the name of the directive to search for containing code cells
:param raw_directive: the name of the directive to search for containing raw cells
:param add_source_map: add a `source_map` key to the notebook metadata,
is a list of the starting source line number for each cell.
:raises MystMetadataParsingError if the metadata block is not valid JSON/YAML
We should just pick one and use that...