docs: Updated Function docstrings and Documentation.pdf - Githubissues

dattalab / moseq2-extract

Here it comes...

Other

3 stars 4 forks source link

docs: Updated Function docstrings and Documentation.pdf #130

Closed aymanzay closed 3 years ago

aymanzay commented 3 years ago

Issue being fixed or feature implemented

Function input parameters and documentation did not exactly match.
Some functions were missing documentation.
Documentation.pdf is out of date.

How Has This Been Tested?

Locally and Travis

What Was Done?

Updated function documentation.
Added document title in docs/conf.py. Source
Generated new Documentation.pdf

Breaking Changes

None

Checklists

[x] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have added or updated relevant unit/integration/functional/e2e tests
[ ] I have made corresponding changes to the documentation