Improve readability of Getting Started guide #3131
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
added 5 commits
January 15, 2018 12:28
Proofread; added intro paragraph under first header to orient new users; fixed grammar errors (switched to active voice, actionable directions, etc) to improve readability
Not issue ID. Will update with pr ID after submitting pr
The-Compiler
requested changes
Jan 19, 2018
|
Done :) |
nicoddemus
approved these changes
Jan 20, 2018
doc/en/getting-started.rst
Outdated
| @@ -177,22 +160,21 @@ before performing the test function call. Let's just run it:: | |||
| PYTEST_TMPDIR/test_needsfiles0 | |||
| 1 failed in 0.12 seconds | |||
|
|
|||
| Before the test runs, a unique-per-test-invocation temporary directory | |||
| was created. More info at :ref:`tmpdir handling`. | |||
| More info on tmpdir handeling is available at `Temporary directories and files <tmpdir handling>`_. | |||
|
Thanks @soyrice. Let's wait for @The-Compiler's review before merging. 👍 |
|
No time right now thanks to exams, so feel free to go ahead 😉 |
|
OK then! 👍 |
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.
New pytest user here! Updated the Getting Started guide to be more readable for new users. Improved grammar, phrasing, etc.