Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some quick-n-dirty documentation addressing #15
These doc files were generated automatically from existing docstrings using pdoc3. It does a pretty good job of parsing most things, and huge shoutout to the maintainers for keeping crisp, clean docstrings, but it cannot catch everything. In particular, I've omitted everything under
note_seq/alignment
. These files are not generated automatically, but if you'd like, we can discuss additional infrastructure to do so.This is certainly not a long-term solution, but a quick fix so users don't have to go digging in source to read the docs. For convenience, I've also tossed the files here, where they can be browsed: https://wlt.coffee/cream/docs/note_seq/
Ideally, we would have a proper readthedocs site, but that would be a much longer, time-consuming project. In the meanwhile, I hope people find this useful!