Constructor signatures missing in types module documentation

Open
#55,985 22 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the existing issue11776-sigs-docs-first.diff and complete-patch-with-table-issue-11776.diff, then compare their proposed changes with the current types module documentation. Check the documented constructors and confirm that their signatures are complete and accurate. Done means the missing constructor signatures are documented and the documentation build or relevant checks pass.

Written by the indexing model from the issue text.

Description

docs type-feature
BPO 11776
Nosy @birkenfeld, @terryjreedy, @ncoghlan, @ezio-melotti, @merwok, @ericsnowcurrently, @eamanu, @csabella, @tza0987
Files
  • issue11776-sigs-docs-first.diff
  • issue11776-first-easy-part-lambda-.diff
  • signatures-full-patch.diff
  • complete-patch-with-table-issue-11776.diff
    		•

    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 2011-04-05.20:53:24.787>
labels = ['easy', '3.8', 'type-feature', '3.7', 'docs']
title = 'Constructor signatures missing in types module documentation'
updated_at = <Date 2019-02-24.23:42:44.704>
user = 'https://bugs.python.org/techtonik'

    bugs.python.org fields:

    activity = <Date 2019-02-24.23:42:44.704>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2011-04-05.20:53:24.787>
creator = 'techtonik'
dependencies = []
files = ['26969', '26982', '27003', '27047']
hgrepos = []
issue_num = 11776
keywords = ['patch', 'easy']
message_count = 22.0
messages = ['133089', '133352', '133354', '133365', '133366', '133374', '133376', '166149', '166152', '168864', '168866', '168901', '168933', '168947', '168992', '169156', '169158', '169159', '169397', '336475', '336478', '336491']
nosy_count = 12.0
nosy_names = ['georg.brandl', 'terry.reedy', 'ncoghlan', 'ezio.melotti', 'eric.araujo', 'docs@python', 'guandalino', 'eric.snow', 'mikehoy', 'eamanu', 'cheryl.sabella', 'Tza0987']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue11776'
versions = ['Python 3.7', 'Python 3.8']

    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.