Expectation#with improvements
#698
Merged
+37
−7
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
The `expected_parameters_or_matchers` argument in the actual method signature is already splatted and so it makes more sense that the `param` YARD tag type does not use a splat.
This seems more consistent with what we've done with the `param` YARD tag type.
This is accidental and possibly undesirable behaviour, but it seems like an improvement to at least document the current behaviour.
Although there was already an example for this and the `yield`, `yieldparam` & `yieldreturn` YARD tags were specified, I think it's helpful to add some explanatory text to the method description. Closes #682.
This is accidental and possibly undesirable behaviour, but it seems like an improvement to at least document the current behaviour. Clarifies potentially confusing behaviour which resulted in the opening of #606.
Previously the output from a test where such an exception was not matched was a bit confusing, because no expected parameters were displayed. While we can't easily display the logic from the block itself, we can at least highlight that such logic does exist. While this will change the content of some test failure messages, I have previously specified that is not part of the documented API. [1] [1]: #577
floehopper
force-pushed
the
expectation-with-improvements
branch
from
a4549c9 to
b30e443
Compare
|
Released in v2.7.1 |
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.
No description provided.