Doc fixes #1469
Merged
Doc fixes #1469
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
The example output shown was for Python3 not Python2. Add Python2 output and rephrase for clarity.
The feature has been there for a long time and in the 2.7.1 release notes it says: > fixed docs to remove the notion that yield-fixtures are experimental. Therefore this one place was probably just missed.
The fin() function was never added as a finalizer and did therefore not print anything in the captured output. In general improve the output by making it more verbose/explicit and extend the final explanation.
Since 'py.test --help' shows --trace-config as an option (and not --traceconfig) even though both forms are accepted I assume --trace-config is the preferred form and should therefore be used in the documentation.
Since 'py.test --help' shows --full-trace as an option (and not --fulltrace) even though both forms are accepted I assume --full-trace is the preferred form and should therefore be used in the documentation.
|
good work, this is a nice cleanup we'd still like a minor change-log entry so people tracking the announcements get a note my personal believ is that someone that does a good contribution also deserves a place in the authors file, but that part is entirely up to you |
|
@RonnyPfannschmidt ok I updated the CHANGELOG. I'll add myself to the AUTHORS when I make some real code contributions ;-) |
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.
Note: I think these minor doc changes require no updates to
AUTHORSorCHANGELOGThanks for submitting a PR, your contribution is really appreciated!
Here's a quick checklist that should be present in PRs:
master; for new features, targetfeatures(targeting master)AUTHORS(See note at the top)CHANGELOG(choose any open position to avoid merge conflicts with other PRs) (See note at the top)