Repository navigation
Fix the parameter order of SetThingStateChange in the COG docs - #70
Closed
seelenkuchen wants to merge 1 commit into
Closed
seelenkuchen wants to merge 1 commit into
seelenkuchen wants to merge 1 commit into
Conversation
The function takes (thing, state, type): the state payload comes before the state-change type. The parameter list and its descriptions now follow that order. Docs only.
Author
|
Closing: this was a mistake on my side. #61 restored the original argument order (thing, type, param), and the existing docs match it. Sorry for the noise. |
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
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 COG docs listed
SetThingStateChange(thing, type, param), but the function takes(thing, state, type): the state payload comes second and the state-change type third. This swaps the signature and parameter descriptions accordingly.Docs only; no code or tests affected.