python / python/cpython

Documentation is unclear how "y*" and "y#" format units vary

Open
#74,810 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.7 (EOL) docs type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 30625
Nosy @skrah, @vadmium, @indygreg

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 2017-06-10.18:16:12.023>
labels = ['type-bug', '3.7', 'docs']
title = 'Documentation is unclear how "y*" and "y#" format units vary'
updated_at = <Date 2017-06-17.03:18:44.489>
user = 'https://github.com/indygreg'

bugs.python.org fields:

activity = <Date 2017-06-17.03:18:44.489>
actor = 'martin.panter'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2017-06-10.18:16:12.023>
creator = 'indygreg'
dependencies = []
files = []
hgrepos = []
issue_num = 30625
keywords = []
message_count = 5.0
messages = ['295649', '296010', '296116', '296182', '296229']
nosy_count = 4.0
nosy_names = ['skrah', 'docs@python', 'martin.panter', 'indygreg']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue30625'
versions = ['Python 3.5', 'Python 3.6', 'Python 3.7']

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

Start by reading the linked BPO issue 30625 and locating the Python documentation that describes the "y*" and "y#" format units. Determine where their behavior is currently explained, then revise the relevant documentation so the variation between the units is explicit and verify the wording against the documented behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.