search

ELVIS-Project / vis-framework

Thoroughly modern symbolic musical data analysis suite.
http://elvisproject.ca/
31 stars 6 forks source link

dissonance indexer Documentation #428

Closed musicus closed 7 years ago

musicus commented 7 years ago

The dissonance indexer is well documented, and features plenty of docsting information.

The docstring information should be formatted in such a way that sphinx will be able to pick it up.

However, it should feature code examples in its run() method as other indexers do, and show anticipated outcomes with using an example.xml file from the vis/tests/corpus/ directory.

alexandermorgan commented 7 years ago

The run() method is a bad place to put essential documentation because several indexers don't have one. This is why I've been moving the most important documentation out of the run methods of indexers. So I don't think this should be done. I'm also unassigning myself because the time to assign stuff to me has long passed, as I mentioned in my email a week or two ago.

musicus commented 7 years ago

Example code is needed for documentation, whether or not is part of the run() method. Where do you suggest to include it?

musicus commented 7 years ago

Docstrings aligned with Sphinx, and code brought into pep8 compliance (mostly).