python / python/cpython

The grammar misses links that are present everywhere else

Open
#89,765 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 45602
Nosy @ambv, @pablogsal, @Arthur-Milchior

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 2021-10-25.02:25:53.051>
labels = ['3.11', 'type-feature', 'docs']
title = 'The grammar misses links that are present everywhere else'
updated_at = <Date 2021-11-02.03:23:50.609>
user = 'https://github.com/Arthur-Milchior'

bugs.python.org fields:

activity = <Date 2021-11-02.03:23:50.609>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-10-25.02:25:53.051>
creator = 'Arthur-Milchior'
dependencies = []
files = []
hgrepos = []
issue_num = 45602
keywords = []
message_count = 1.0
messages = ['404946']
nosy_count = 4.0
nosy_names = ['docs@python', 'lukasz.langa', 'pablogsal', 'Arthur-Milchior']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'test needed'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45602'
versions = ['Python 3.11']

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

Read the migrated BPO issue 45602 and compare the documentation grammar with the other locations where links are present. No source file or test is identified in the issue, so first locate the relevant documentation grammar and its checks; done means the missing links are represented consistently with those other locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.