Fix missing return code for ws2812_init() #1816
Merged
Conversation
This file contains 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
devsaurus
changed the title
marcelstoer
reviewed
Feb 24, 2017
| to Lua's serial console as it shares the same UART and PIN. | ||
| - `mode` (optional) either `ws2812.MODE_SINGLE` (default if omitted) or `ws2812.MODE_DUAL` | ||
|
|
||
| In `ws2812.MODE_DUAL` mode you will be able to handle two strips in parallel but will lose access to Lua's serial console as it shares the same UART and PIN. | ||
|
|
||
| #### Returns | ||
| `nil` |
There was a problem hiding this comment.
Didn't you just change that in the code?
There was a problem hiding this comment.
The code change tells the caller of ws2812_init() that 0 results are returned on the stack aka nil. Before that, if told to print the result eg, the calling function would pick up a random value (since ws2812_init() didn't set a return value) and thus extract a random number of items from the stack, causing the crash.
There was a problem hiding this comment.
Got it, thanks for the explanation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1815.
devbranch rather than formaster.docs/en/*.Like all Lua functions,
ws2812_init()must return number of pushed elements onto stack.Small corrections for
ws2812.init()API doc formatting.