Skip to content

Replace backquote with command substitution #13941

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jul 16, 2019
Merged

Replace backquote with command substitution #13941

merged 3 commits into from
Jul 16, 2019

Conversation

drj11
Copy link
Contributor

@drj11 drj11 commented Jun 10, 2019

Backquote is somewhat deprecated in shell programming (not formally, but by many practitioners).

This PR replaces backquotes with command substitution.

In the subprocess module documentation.

@drj11 drj11 requested a review from gpshead as a code owner June 10, 2019 13:34
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jun 10, 2019
@drj11
Copy link
Contributor Author

drj11 commented Jun 10, 2019

I think that skip news is appropriate (I can't add the label), and I would urge that skip issue may be appropriate.

@drj11
Copy link
Contributor Author

drj11 commented Jun 11, 2019

This requires an edit to Doc/tools/susp-ignored.csv.

Discovering that was made much more difficult because #13579 hasn't been merged yet.

asottile
asottile approved these changes Jun 18, 2019 •
edited
Loading
View reviewed changes
@drj11
Copy link
Contributor Author

drj11 commented Jul 16, 2019

Any chance of a review on this one @gpshead and/or lifting the bedevere restrictions?

gpshead
gpshead approved these changes Jul 16, 2019
View reviewed changes
Copy link
Member

@gpshead gpshead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are still going to be shell scripts using backquotes that people are wrangling out there, but overall agreed, lets use the more common modern shell syntax in the example. bonus, as you noticed, this is easier in ReST as we don't need susp-ignored entry.

@gpshead gpshead merged commit 6a61714 into python:master Jul 16, 2019
@miss-islington
Copy link
Contributor

Thanks @drj11 for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-14793 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 16, 2019
@drj11 @miss-islington
Replace backquote with command substitution in subprocess doc example (…
61259c6 
…pythonGH-13941)

Replace backquotes with POSIXy command substitution in example.
(cherry picked from commit 6a61714)

Co-authored-by: David Jones <drj@pobox.com>
miss-islington added a commit that referenced this pull request Jul 16, 2019
@miss-islington @drj11
Replace backquote with command substitution in subprocess doc example (…
86742d4 
…GH-13941)

Replace backquotes with POSIXy command substitution in example.
(cherry picked from commit 6a61714)

Co-authored-by: David Jones <drj@pobox.com>
@drj11
Copy link
Contributor Author

drj11 commented Jul 16, 2019

Don't worry @gpshead the rest-of-the-world is also on my todo list for converting to "modern" shell syntax. :)

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@drj11 @lisroach
Replace backquote with command substitution in subprocess doc example (…
6d36b53 
…pythonGH-13941)

Replace backquotes with POSIXy command substitution in example.
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@drj11 @DinoV
Replace backquote with command substitution in subprocess doc example (…
5df8df4 
…pythonGH-13941)

Replace backquotes with POSIXy command substitution in example.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gpshead gpshead gpshead approved these changes

@asottile asottile asottile approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@drj11 @the-knights-who-say-ni @miss-islington @bedevere-bot @gpshead @asottile