Skip to content

Add PEP titles and sections as reference title text - #2366

Merged
AA-Turner merged 2 commits into
python:mainfrom
AA-Turner:pep-reference-title-title
Feb 27, 2022
Merged

AA-Turner merged 2 commits into
python:mainfrom
AA-Turner:pep-reference-title-title

Conversation

@AA-Turner

Copy link
Copy Markdown
Member

This adds the PEP number, title, and section target title to the title text of the link element.

A

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I spot tested this on a few different PEPs and PEP link types, and everything worked great—I particularly liked the inclusion of the section name; that was a very thoughtful and useful touch. I only had one small comment on the formatting of the titletext, and one nitpick on formatting the code.

Comment thread pep_sphinx_extensions/pep_processor/transforms/pep_references.py Outdated
Comment thread pep_sphinx_extensions/pep_processor/parsing/pep_role.py Outdated

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, @AA-Turner , this is a terrific improvement. This should be good to merge at your convenience.

@CAM-Gerlach

Copy link
Copy Markdown
Member

☝️ Just FYI, @warsaw , since IIRC you requested this.

Also, @AA-Turner 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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants