Punctuation and minor style corrections in “Installing Packages” - #2137
MikhailRyazanov wants to merge 2 commits into
Conversation
| Managing multiple virtual environments directly can become tedious, so the | ||
| :ref:`dependency management tutorial <managing-dependencies>` introduces a | ||
| higher level tool, :ref:`Pipenv`, that automatically manages a separate | ||
| higher-level tool :ref:`Pipenv` that automatically manages a separate |
There was a problem hiding this comment.
Not sure about this one. Does not sound right to me...
There was a problem hiding this comment.
It may be that different people use different writing style guides and dictionaries (as in US vs en_GB vs en_CA vs en_AU etc). We've never attempted to enforce a specific one and I believe the consensus was that any of those work for as long as it's not an unreadable nonsense..
I'll let @ncoghlan make a call as a native speaker of one of those, though.
There was a problem hiding this comment.
Overall, these edits seem redundant, so I'm leaning towards a -1, or at least -0 on the PR as a whole but won't block if anyone feels otherwise.
There was a problem hiding this comment.
Not sure about this one. Does not sound right to me...
“... introduces :ref:`Pipenv`, a higher-level tool that automatically manages ...” (with slightly rearranged words) would be better.
There was a problem hiding this comment.
Yes, keep the apposition (commas)
There was a problem hiding this comment.
Not sure about this one. Does not sound right to me...
“... introduces
:ref:`Pipenv`, a higher-level tool that automatically manages ...” (with slightly rearranged words) would be better.
Yes, looks better to me
There was a problem hiding this comment.
Yes, keep the apposition (commas)
The apposition remains regardless of the commas, but the commas were marking it as non-restrictive, which doesn’t make much sense in this case, since Pipenv is the main object (even reflinked). Now I’ve changed the order to make this clear and the flow smoother.
Rephrase the introduction of Pipenv for clarity.
4 participants
Minor proofreading of that tutorial.
The main reason was the eyesoring “pip`s" (with a backtick instead of an apostrophe), but I also went through other problematic punctuation and rearranged “Installing from VCS” more consistently and logically.
📚 Documentation preview 📚: https://python-packaging-user-guide--2137.org.readthedocs.build/en/2137/