Improve clarity of signal.siginterrupt docs

Open
#69,745 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the documentation entry for signal.siginterrupt and reviewing its current wording against the reported typo and clarity problem. Done means the entry accurately and clearly describes the API, with the reported wording issue corrected.

Written by the indexing model from the issue text.

Description

docs type-feature
BPO 25559
Nosy @vstinner, @bitdancer

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-11-05.16:54:37.756>
labels = ['type-feature', 'docs']
title = 'signal.siginterrupt description has typo'
updated_at = <Date 2015-11-05.20:30:22.448>
user = 'https://bugs.python.org/TomMeagher'

bugs.python.org fields:

activity = <Date 2015-11-05.20:30:22.448>
actor = 'vstinner'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2015-11-05.16:54:37.756>
creator = 'Tom Meagher'
dependencies = []
files = []
hgrepos = []
issue_num = 25559
keywords = []
message_count = 3.0
messages = ['254121', '254132', '254140']
nosy_count = 4.0
nosy_names = ['vstinner', 'r.david.murray', 'docs@python', 'Tom Meagher']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue25559'
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.