google-cla[bot]
commented
3 years ago Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).
:memo: Please visit https://cla.developers.google.com/ to sign.
Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.
What to do if you already signed the CLA
Individual signers
- It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.
Corporate signers
- Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
- The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
- The email used to register you as an authorized contributor must also be attached to your GitHub account.
ℹ️ Googlers: Go here for more info.
wtong98
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!