More detailed usage example in README.md #16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current code snippet in README.md is rather confusing and doesn't reflect relevant implementation details, such as how to instantiate the BasicPitch class. The provided example (which is admittedly lengthly) is ready to use, and includes docstring + explanatory comments.
|
This was really useful! One more detail is that the file must be mono. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The current code snippet in
README.mdis rather confusing and doesn't reflect relevant implementation details, such as how to instantiate theBasicPitchclass, or clarifying that theAudioContext's sampling rate must be 22050. The provided example (which is admittedly lengthly) is copy-paste ready, and includes a docstring + explanatory comments.