Updated frequency minumum requirements in docs and examples#444
Merged
Conversation
Please enter the commit message for your changes. Lines starting
tannewt
requested changes
Nov 17, 2017
| //| :param ~microcontroller.Pin clock_pin: The pin to output the clock to | ||
| //| :param ~microcontroller.Pin data_pin: The pin to read the data from | ||
| //| :param int frequency: Target frequency of the resulting samples. Check `frequency` for real value. | ||
| //| :param int frequency: Target frequency of the resulting samples. Check `frequency` for real value. Must be minimum of 16000 |
Member
There was a problem hiding this comment.
Instead of adding a note here, how about a full sentence before the first :param:? That way it can explain the total 1mhz frequency requirement that is determined by frequency * oversample.
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
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.
No description provided.