ERC-BPGC/gennav

Improve docs

threewisemonkeys-as opened this issue · 1 comments

  1. Organise docs into logical sections
  2. Add intro text
  3. Add examples
  4. Fix minor formatting issues in docstrings (good first issue)

We are using this style guide

Point 1 and 2 have been sufficiently covered for now. Examples will be part of #36 and #35 anyways. So major point here is 4. A lot of docstrings arent well formatted as of now so that needs ot be corrected so the docs become better