Not documented special names

Open
#67,827 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing index-special.patch, described as indexing existing documentation, and compare it with the four listed documentation dependencies: self, sizeof, getinitargs, and base. Check the linked issue context and determine whether the special names are now documented; done means the relevant existing documentation is indexed or clarified without leaving those dependencies unresolved.

Written by the indexing model from the issue text.

Description

docs type-feature
BPO 23639
Nosy @birkenfeld, @rhettinger, @terryjreedy, @ezio-melotti, @merwok, @vadmium, @serhiy-storchaka, @IanLee1521
Dependencies
  • bpo-14003: self on built-in functions is not as documented
  • bpo-15436: sizeof is not documented
  • bpo-22392: Clarify documentation of getinitargs
  • bpo-22456: base undocumented
    		•
    Files
  • index-special.patch: Index existing documentation
    		•

    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 2015-03-11.11:15:01.029>
labels = ['type-feature', 'docs']
title = 'Not documented special names'
updated_at = <Date 2015-09-02.18:13:56.514>
user = 'https://github.com/serhiy-storchaka'

    bugs.python.org fields:

    activity = <Date 2015-09-02.18:13:56.514>
actor = 'serhiy.storchaka'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2015-03-11.11:15:01.029>
creator = 'serhiy.storchaka'
dependencies = ['14003', '15436', '22392', '22456']
files = ['39793']
hgrepos = []
issue_num = 23639
keywords = ['patch']
message_count = 7.0
messages = ['237859', '237860', '237886', '238005', '238063', '245716', '249385']
nosy_count = 10.0
nosy_names = ['georg.brandl', 'rhettinger', 'terry.reedy', 'peter.otten', 'ezio.melotti', 'eric.araujo', 'docs@python', 'martin.panter', 'serhiy.storchaka', 'IanLee1521']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue23639'
versions = ['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.