subprocess.check_output() docs misrepresent what shell=True does

Open
#64,543 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Review the subprocess.check_output() documentation and the attached issue20344.patch, documentation20344.patch, 20344_3.patch, and 20344_4.patch. Compare the documented shell=True behavior with the intended behavior, then confirm the wording is accurate and run the relevant documentation checks.

Written by the indexing model from the issue text.

Description

docs stdlib topic-subprocess type-bug
BPO 20344
Nosy @bitdancer, @vadmium
Files
  • issue20344.patch: Patch to issue 20344
  • documentation20344.patch
  • 20344_3.patch
  • 20344_4.patch
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = None
created_at = <Date 2014-01-22.14:25:04.959>
labels = ['type-bug', 'library', 'docs']
title = 'subprocess.check_output() docs misrepresent what shell=True does'
updated_at = <Date 2015-06-20.06:25:51.399>
user = 'https://bugs.python.org/klausman'

    bugs.python.org fields:

    activity = <Date 2015-06-20.06:25:51.399>
actor = 'martin.panter'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2014-01-22.14:25:04.959>
creator = 'klausman'
dependencies = []
files = ['34543', '34619', '34635', '39747']
hgrepos = []
issue_num = 20344
keywords = ['patch']
message_count = 12.0
messages = ['208811', '208814', '214332', '214364', '214845', '214943', '214949', '214950', '243632', '243638', '243642', '245542']
nosy_count = 5.0
nosy_names = ['r.david.murray', 'docs@python', 'klausman', 'martin.panter', 'Tuomas.Savolainen']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue20344'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6']

    Dominant language
    Python
    Stars
    77.2k
    Forks
    36k
    Avg merge
    1d 9h
    Merged PRs (30d)
    558

    Contributor guide

    Open the contributing guide

    First steps

    1. Read the whole issue, then the project's contributing guide.
    2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
    3. Fork the repository and make your change on a branch.
    4. Open a pull request that references the issue number.

    More from python/cpython

    All issues in python/cpython

    Similar issues

    More Python issues

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.