Updated documentation on using fixtures #98
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
bittner
reviewed
Apr 7, 2019
docs/usage.rst
Outdated
| a convenient way to keep fixtures close to your steps. | ||
| a convenient way to keep fixtures close to your steps. **Caveat:** if *any* step | ||
| in a scenario uses the fixture decorator, **all** steps in the scenario will | ||
| have the fixture loaded. |
There was a problem hiding this comment.
This sounds scary, but isn't this actually somewhat "normal"? What would a "confusing" situation look like?
Hence, do you think that deserves the tone of warning?
Maybe a dedicated "Note" paragraph or box explaining the technical reason, saying, "Just keep in mind ..." (like above) would do the job?
There was a problem hiding this comment.
In any case, let's stick to semantic markup and text structure:
- The warning is separate unit of information
- It should probably come after the code sample (i.e. first motivate, show, then warn)
- The caveat paragraph should probably be marked up as admonition
There was a problem hiding this comment.
Update pushed. See if that is better
bittner
reviewed
Apr 8, 2019
|
Thank you for updating the documentation! 👍 🥇 |
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.
This fixes #91: I included details of how
context.fixturesdo not automatically reset between features/scenarios, and then described how using the fixture decorator on a step causes the fixture to load on all other steps that it shares a scenario with.