Added order and check_params_cbs parameter documentation (also to changelog) #149
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
…er documentation to waitSignals. Added check_params_cbs and order parameter documentation to waitSignals. #147
docs/signals.rst
Outdated
| .. versionadded:: 2.0 | ||
|
|
||
| If the signal has parameters you want to compare with expected values, you can pass | ||
| ``check_params_cb=some_callable(*parameters)`` that compares the provided signal parameters to some expected parameters. |
Member
There was a problem hiding this comment.
The (*parameters) seems confusing to me here - why not leave it off?
Member
|
Great docs! Note that the title underlining should be the same length as the title, otherwise rst-lint will fail. I also added some minor comments. |
Member
|
Thanks a lot! 😄 |
Author
|
No problem ;) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Added order parameter to 2.0 changelog. Added check_params_cb parameter documentation to waitSignals. Added check_params_cbs and order parameter documentation to waitSignals.