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

Minor updates to the documentation #1540

merged 11 commits into from
Feb 5, 2020

Conversation

pradyunsg
Copy link
Member

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
Copy link
Member Author

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
Copy link
Contributor

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
@pradyunsg pradyunsg deleted the docs-updates branch February 5, 2020 11:39
@pradyunsg
Copy link
Member Author

🥂

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

@gaborbernat
Copy link
Contributor

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
gaborbernat added a commit that referenced this pull request Feb 10, 2020
gaborbernat added a commit that referenced this pull request Feb 10, 2020
gaborbernat added a commit that referenced this pull request Feb 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants