Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor updates to the documentation #1540

Merged
merged 11 commits into from Feb 5, 2020
Merged

Conversation

@pradyunsg
Copy link
Member

pradyunsg commented Feb 4, 2020

Miscellaneous updates following #1519.

Fixes typos, repeated words and inconsistent heading spacing
Repharses parts of the development documentation and CLI documentation.
Expands shorthands like "env var" and "config" to their full forms.
Uses descriptions from respective documentation, for projects listed in "related links".

Feel free to push additional changes to override these, since I'm gonna head to bed now.

pradyunsg added 8 commits Feb 4, 2020
Use lightly-modified descriptions from projects' documentation/PyPI page
@pradyunsg

This comment has been minimized.

Copy link
Member Author

pradyunsg commented Feb 4, 2020

There are a few more issues that proselint identified, which we may/may not be worth addressing:

./docs/development.rst:125:34: after_the_deadline.redundancy Redundancy. Use 'facilitate' instead of 'facilitate easier'.
./docs/development.rst:152:6: consistency.spacing Inconsistent spacing after period (1 vs. 2 spaces).
./docs/development.rst:169:49: after_the_deadline.redundancy Redundancy. Use 'same' instead of 'exact same'.
./docs/development.rst:180:21: typography.symbols.ellipsis '...' is an approximation, use the ellipsis symbol '…'.
./docs/index.rst:35:13: needless_variants.misc Needless variant. 'extendable' is the preferred form.
./docs/index.rst:42:44: consistency.spacing Inconsistent spacing after period (1 vs. 2 spaces).
./docs/index.rst:45:80: consistency.spacing Inconsistent spacing after period (1 vs. 2 spaces).
./docs/user_guide.rst:45:44: weasel_words.very Substitute 'damn' every time you're inclined to write 'very'; your editor will delete it and the writing will be just as it should be. Found once elsewhere.
gaborbernat added 3 commits Feb 5, 2020
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
@gaborbernat

This comment has been minimized.

Copy link
Contributor

gaborbernat commented Feb 5, 2020

I've made some small additions, but this is now ready to go once the CI passes.

thanks

@gaborbernat gaborbernat merged commit c281e04 into pypa:rewrite Feb 5, 2020
35 checks passed
35 checks passed
continuous-documentation/read-the-docs Read the Docs build succeeded!
Details
pypa.virtualenv Build #pypa.virtualenv_20200205.02 succeeded
Details
pypa.virtualenv (dev linux) dev linux succeeded
Details
pypa.virtualenv (docs linux) docs linux succeeded
Details
pypa.virtualenv (docs windows) docs windows succeeded
Details
pypa.virtualenv (fix_lint linux) fix_lint linux succeeded
Details
pypa.virtualenv (fix_lint windows) fix_lint windows succeeded
Details
pypa.virtualenv (py27 linux) py27 linux succeeded
Details
pypa.virtualenv (py27 macOs) py27 macOs succeeded
Details
pypa.virtualenv (py27 windows) py27 windows succeeded
Details
pypa.virtualenv (py35 linux) py35 linux succeeded
Details
pypa.virtualenv (py35 macOs) py35 macOs succeeded
Details
pypa.virtualenv (py35 vs2017-win2016) py35 vs2017-win2016 succeeded
Details
pypa.virtualenv (py36 linux) py36 linux succeeded
Details
pypa.virtualenv (py36 macOs) py36 macOs succeeded
Details
pypa.virtualenv (py36 vs2017-win2016) py36 vs2017-win2016 succeeded
Details
pypa.virtualenv (py37 linux) py37 linux succeeded
Details
pypa.virtualenv (py37 macOs) py37 macOs succeeded
Details
pypa.virtualenv (py37 vs2017-win2016) py37 vs2017-win2016 succeeded
Details
pypa.virtualenv (py38 linux) py38 linux succeeded
Details
pypa.virtualenv (py38 macOs) py38 macOs succeeded
Details
pypa.virtualenv (py38 vs2017-win2016) py38 vs2017-win2016 succeeded
Details
pypa.virtualenv (pypy linux) pypy linux succeeded
Details
pypa.virtualenv (pypy macOs) pypy macOs succeeded
Details
pypa.virtualenv (pypy windows) pypy windows succeeded
Details
pypa.virtualenv (pypy3 linux) pypy3 linux succeeded
Details
pypa.virtualenv (pypy3 macOs) pypy3 macOs succeeded
Details
pypa.virtualenv (pypy3 windows) pypy3 windows succeeded
Details
pypa.virtualenv (readme linux) readme linux succeeded
Details
pypa.virtualenv (readme windows) readme windows succeeded
Details
pypa.virtualenv (report_coverage) report_coverage succeeded
Details
pypa.virtualenv (upgrade linux) upgrade linux succeeded
Details
pypa.virtualenv (upgrade windows) upgrade windows succeeded
Details
pypa.virtualenv (zipapp linux) zipapp linux succeeded
Details
pypa.virtualenv (zipapp windows) zipapp windows succeeded
Details
@pradyunsg pradyunsg deleted the pradyunsg:docs-updates branch Feb 5, 2020
@pradyunsg

This comment has been minimized.

Copy link
Member Author

pradyunsg commented Feb 5, 2020

🥂

You're much better at GIFs than I am. :P

@gaborbernat

This comment has been minimized.

Copy link
Contributor

gaborbernat commented Feb 5, 2020

Note the latest rewrite branch doc is available under https://virtualenv.pypa.io/en/rewrite/index.html

gaborbernat added a commit that referenced this pull request Feb 10, 2020
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
gaborbernat added a commit that referenced this pull request Feb 10, 2020
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
gaborbernat added a commit that referenced this pull request Feb 10, 2020
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
gaborbernat added a commit that referenced this pull request Feb 10, 2020
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.