Sync README, docs and code behavior#490
Merged
WasabiFan merged 5 commits intoev3dev-stretchfrom Jul 29, 2018
Merged
Conversation
Minor improvement to LED parameter options.
ddemidov
reviewed
Jul 29, 2018
|
|
||
| sound = Sound() | ||
| sound.speak('Welcome to the E V 3 dev project!').wait() | ||
| sound.speak('Welcome to the E V 3 dev project!') |
Member
There was a problem hiding this comment.
I started to comment asking why did we remove this, when we still are returning Popen objects from Sound methods, then noticed we mostly don't anymore. The exception is beep, which still needs .wait() to make it synchronous. Should it be changed as well?
Member
Author
There was a problem hiding this comment.
Good point. I'll modify beep to match the behavior of the other methods.
Member
Author
There was a problem hiding this comment.
I've updated beep and its derivative tone, and in the process fixed the docs example because these methods aren't static anymore.
ddemidov
approved these changes
Jul 29, 2018
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.
Also, minor improvement to LED parameter options.
The docs in the
Soundclass were quite badly formatted after going through Sphinx so I updated all of those methods to use the standard Sphinx/reST style which will be rendered properly. It would be nice to update other areas to do the same.