-
-
Notifications
You must be signed in to change notification settings - Fork 963
Update bootcamp FAQ about "Checking out others' PRs" #1694
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
Conversation
@hugovk
hugovk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And replace the other two git checkout on this page with git switch?
And also on getting-started/pull-request-lifecycle.rst and index.rst?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most command in the page have the $, even though I don't remember if there was a specific reason/convention, so I didn't remove it. We could remove most/all of them in a separate PR.
https://devguide.python.org/documentation/style-guide/#code-examples says to use prompts sparingly to differentiate input/output lines, even though it's talking mainly about Python >>>/.... We could remove most/all of them in a separate PR.
Also note that the shell highlight is for shell scripts, whereas the console highlight for shell sessions with prompts (see https://pygments.org/docs/lexers/#lexers-for-various-shells).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, console is useful when you have a prompt and output to show. Otherwise shell for plain commands.
Console:
$ ls | wc -l # good formatting for command + output 👍 158
ls | wc -l # bad formatting for command 👎 Shell:
$ ls | wc -l # bad formatting for output 👎 158
ls | wc -l # good formatting for command 👍
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most command in the page have the $, even though I don't remember if there was a specific reason/convention, so I didn't remove it. We could remove most/all of them in a separate PR.
https://devguide.python.org/documentation/style-guide/#code-examples says to use prompts sparingly to differentiate input/output lines, even though it's talking mainly about Python >>>/.... We could remove most/all of them in a separate PR.
Also note that the shell highlight is for shell scripts, whereas the console highlight for shell sessions with prompts (see https://pygments.org/docs/lexers/#lexers-for-various-shells).
Uh oh!
There was an error while loading. Please reload this page.
I wanted to pull a PR branch and I was looking up "Checking out others' PRs", and the options were either to install
gh,hub, or creating a Git alias.Since I wanted a less permanent solution, I created this PR to show the commands individually before suggesting adding them as an alias. In addition I replaced
checkoutwith the more modernswitch, and capitalized "Git".Another possible solution is to add the contributor's repo as a remote and fetch their branch from there, but I didn't want to add yet another solution. If people want to add it, we can create another PR.
📚 Documentation preview 📚: https://cpython-devguide--1694.org.readthedocs.build/