Skip to content

Fix styling of docstrings

  • Many doc strings are formatted in ways that are not parsed properly by Sphinx.
  • Many functions are used by the tutorials, but their API documentation is not linked

DoD

  • Assess amount of formatting that needs to be done. -> 50 docstrings
  • Format remaining doc strings.
  • Link API from function names in tutorials.

This is a followup issue for #65 (closed).

Edited by Daniel Hornung
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information