python / python/cpython

Termios module documentation is extremely lacking

Open
#86,568 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.9 (EOL) docs
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 42402
Nosy @iritkatriel

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 2020-11-19.07:54:10.436>
labels = ['3.9', 'docs']
title = 'Termios module documentation is extremely lacking'
updated_at = <Date 2021-02-19.17:39:55.648>
user = 'https://bugs.python.org/danmerillat'

bugs.python.org fields:

activity = <Date 2021-02-19.17:39:55.648>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-11-19.07:54:10.436>
creator = 'dan.merillat'
dependencies = []
files = []
hgrepos = []
issue_num = 42402
keywords = []
message_count = 3.0
messages = ['381393', '381394', '387337']
nosy_count = 3.0
nosy_names = ['docs@python', 'iritkatriel', 'dan.merillat']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue42402'
versions = ['Python 3.9']

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.

Research direction

No file or test is named in the issue. Start by locating the Termios module documentation and reviewing what is missing; done means the documentation gaps are covered, but the issue does not define those gaps.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.