Allow to override a function signature for pydoc with a docstring

Open
#61,046 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by locating pydoc's handling of function signatures and the related docstring processing. The issue names no files or tests, so first determine the relevant entry point and existing signature-rendering tests; done means a documented docstring-based signature override is supported and covered by tests.

Written by the indexing model from the issue text.

Description

interpreter-core type-feature
BPO 16842
Nosy @birkenfeld, @merwok, @meadori, @serhiy-storchaka

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-01-02.20:08:25.849>
labels = ['interpreter-core', 'type-feature']
title = 'Allow to override a function signature for pydoc with a docstring'
updated_at = <Date 2021-06-29.13:47:58.655>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2021-06-29.13:47:58.655>
actor = 'eric.araujo'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Interpreter Core']
creation = <Date 2013-01-02.20:08:25.849>
creator = 'serhiy.storchaka'
dependencies = []
files = []
hgrepos = []
issue_num = 16842
keywords = []
message_count = 4.0
messages = ['178846', '178880', '178930', '396727']
nosy_count = 4.0
nosy_names = ['georg.brandl', 'eric.araujo', 'meador.inge', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue16842'
versions = []

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.