python / python/peps

Investigate adding footnote title text

Open
#2,371 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
reStructuredText
Stars
5k
Forks
1.8k
Avg merge
2d 4h
Merged PRs (30d)
25

Description

... would it be straightforward to add similar titletext popups in a future PR for footnotes with the footnote content (like Wikipedia has), to avoid users having to click around to find it?

xref https://github.com/python/peps/issues/2366#issuecomment-1053674181

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 with the linked comment in python/peps#2366 and determine how footnotes are currently represented and rendered. Define whether title-text popups containing footnote content are feasible, and document the required scope and completion criteria for a future pull request.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.