Add Windows tab for some commands #942
Conversation
Co-authored-by: Brian Rutledge <[email protected]>
|
I will use prompts when there are outputs of commands only. |
source/contribute.rst
Outdated
| @@ -79,7 +79,7 @@ need: | |||
| 1. `Nox <https://nox.readthedocs.io/en/latest/>`_. You can install or upgrade | |||
| nox using ``pip``:: | |||
|
|
|||
| python -m pip install --user nox | |||
| python3 -m pip install --user nox | |||
There was a problem hiding this comment.
This doesn't look related to having windows tabs.
There was a problem hiding this comment.
I want to update python to python3 at the same time. However, is this should be fixed in another PR?
There was a problem hiding this comment.
That sounds like a separate change to me. The rule of thumb is to make PRs (and individual commits for that matter) atomic.
https://seesparkbox.com/foundry/atomic_commits_with_git
In particular, not following this practice makes things confusing for people who try to figure out what's going on here: the title says one thing, then the description may advertise another set of changes but the code differs even more. As a nice side-effect, small self-contained changes make it easier for reviewers to understand things and give feedback+merge faster.
If there's gazillion changes present, it encourages people to postpone the review "for later". Also, if there is a small change that could be approved right away, it'll still have to wait for all of the other unsuitable changes to be fixed first to be merged which is rather unfair.
There was a problem hiding this comment.
Here's a nice article on this topic: https://mtlynch.io/code-review-love/.
There was a problem hiding this comment.
Thanks for these articles! :)
I will read them.
| :: | ||
|
|
||
| $ pipx install PACKAGE | ||
| $ ENTRYPOINT_OF_PACKAGE [ARGS] | ||
| ENTRYPOINT_OF_PACKAGE [ARGS] |
There was a problem hiding this comment.
This looks weird. I would never have guessed that it's a placeholder for a command w/o a prompt. Dunno what to do about it...
There was a problem hiding this comment.
Probably prompt should be remained here.
source/guides/using-testpypi.rst
Outdated
| @@ -28,7 +28,7 @@ the ``--repository`` flag | |||
|
|
|||
| .. code:: | |||
|
|
|||
| $ twine upload --repository testpypi dist/* | |||
| twine upload --repository testpypi dist/* | |||
There was a problem hiding this comment.
This prompt-removal crusade doesn't seem to be related to adding the windows tabs either
There was a problem hiding this comment.
yes, but @bhrutledge started this here. 🤣
There was a problem hiding this comment.
I see. Still, let's try to keep PRs dedicated to a single cause each. Where it's possible, of course :)
There was a problem hiding this comment.
Okay, and I will revoke these changes and open a new PR for these. :)
There was a problem hiding this comment.
Apologies for the confusion. I thought it would be a small amount of extra scope, that would improve consistency. I see how it was too much. Thanks @meowmeowmeowcat and @webknjaz for bearing with me.
|
|
||
| $ pipx install PACKAGE |
There was a problem hiding this comment.
If we're keeping the prompt, the console lexer should be used.
There was a problem hiding this comment.
yes, and this will be solved in another PR.
There was a problem hiding this comment.
Since this was the only remaining unrelated change, I reverted it 307732b.
Some commands are missing Windows tabs so I've added them.