python / python/cpython

Glossary URLs with anchor link no longer jump to definitions

Open
#90,492 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.10 3.11 docs type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 46334
Nosy @rhettinger, @JulienPalard, @treyhunner, @AlexWaygood

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 2022-01-10.17:20:52.535>
labels = ['3.11', 'type-bug', '3.10', 'docs']
title = 'Glossary URLs with anchor link no longer jump to definitions'
updated_at = <Date 2022-01-11.04:50:58.978>
user = 'https://github.com/treyhunner'

bugs.python.org fields:

activity = <Date 2022-01-11.04:50:58.978>
actor = 'ned.deily'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2022-01-10.17:20:52.535>
creator = 'trey'
dependencies = []
files = []
hgrepos = []
issue_num = 46334
keywords = []
message_count = 3.0
messages = ['410234', '410235', '410247']
nosy_count = 5.0
nosy_names = ['rhettinger', 'docs@python', 'mdk', 'trey', 'AlexWaygood']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue46334'
versions = ['Python 3.10', '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

Start by locating the documentation glossary definitions and the code or configuration that generates their URLs, then reproduce an anchor link in the rendered documentation. Done means glossary URLs containing anchors jump directly to the corresponding definitions in the published docs.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.