Opened 8 years ago

Closed 8 years ago

Last modified 5 years ago

#8539 closed (fixed)

Two PEP links broken in new documentation

Reported by: Carl Meyer Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

In docs/internals/contributing.txt and docs/topics/testing.txt, a PEP is referenced without the necessary backticks (:pep:8 instead of :pep:8), so the generated HTML does not link to the PEP.

Grepping the docs seems to indicate that these are the only two docs with that problem.

Attached patch fixes the problem.

Attachments (1)

doc-peps.diff (1.3 KB) - added by Carl Meyer 8 years ago.
Backtick-quote PEP references in docs

Download all attachments as: .zip

Change History (5)

Changed 8 years ago by Carl Meyer

Attachment: doc-peps.diff added

Backtick-quote PEP references in docs

comment:1 Changed 8 years ago by Carl Meyer

Whoops, WikiFormatting ate my backticks in the description. Should read:

:pep:8 instead of :pep:`8`

comment:2 Changed 8 years ago by Thejaswi Puthraya

Triage Stage: UnreviewedReady for checkin

comment:3 Changed 8 years ago by Jacob

Resolution: fixed
Status: newclosed

Fixed in [8552].

comment:4 Changed 5 years ago by Jacob

milestone: 1.0

Milestone 1.0 deleted

Note: See TracTickets for help on using tickets.
Back to Top