python / python/cpython

Consider improving the clarity of unittest.mock.create_autospec

Open
#74,733 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 30548
Nosy @csabella, @mariocj89, @tirkarthi

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 2017-06-02.09:06:21.041>
labels = ['type-feature', 'docs']
title = 'typo in documentation for create_autospec'
updated_at = <Date 2019-10-30.08:35:30.452>
user = 'https://bugs.python.org/ErikBystrm'

bugs.python.org fields:

activity = <Date 2019-10-30.08:35:30.452>
actor = 'Erik Bystr\xc3\xb6m'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2017-06-02.09:06:21.041>
creator = 'Erik Bystr\xc3\xb6m'
dependencies = []
files = []
hgrepos = []
issue_num = 30548
keywords = []
message_count = 4.0
messages = ['294993', '305609', '334361', '355697']
nosy_count = 5.0
nosy_names = ['docs@python', 'cheryl.sabella', 'mariocj89', 'Erik Bystr\xc3\xb6m', 'xtreak']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue30548'
versions = ['Python 3.6']

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.

Research direction

Search the documentation for unittest.mock.create_autospec and read the surrounding wording to identify the reported typo or clarity issue. Confirm the intended wording from the API description, then update the documentation and verify that the create_autospec section is clear and accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.