Different documentation for identical methods

Open
#62,058 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reading the linked BPO issue 17858 and comparing the four uploaded patches: issue17858.patch through Patch 4. Identify which identical methods require different documentation and confirm the intended wording from the issue discussion. Done means the documentation discrepancy is resolved and the relevant documentation tests or checks pass.

Written by the indexing model from the issue text.

Description

docs type-feature
BPO 17858
Nosy @birkenfeld, @bitdancer
Files
  • issue17858.patch: patch for issue 17858
  • issue17858.patch: Issue 17858 Patch 2
  • issue17858.patch: Issue 17858 Patch 3
  • issue17858.patch: issue 17858 Patch 4
    		•

    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 2013-04-27.22:58:04.996>
labels = ['type-feature', 'docs']
title = 'Different documentation for identical methods'
updated_at = <Date 2013-05-09.15:19:20.670>
user = 'https://bugs.python.org/amysyk'

    bugs.python.org fields:

    activity = <Date 2013-05-09.15:19:20.670>
actor = 'amysyk'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2013-04-27.22:58:04.996>
creator = 'amysyk'
dependencies = []
files = ['30039', '30047', '30136', '30184']
hgrepos = []
issue_num = 17858
keywords = ['patch']
message_count = 9.0
messages = ['187945', '187946', '187947', '187948', '187965', '188004', '188450', '188717', '188781']
nosy_count = 4.0
nosy_names = ['georg.brandl', 'r.david.murray', 'docs@python', 'amysyk']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue17858'
versions = ['Python 3.4']

    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.