Code

Opened 6 years ago

Closed 6 years ago

Last modified 3 years ago

#8539 closed (fixed)

Two PEP links broken in new documentation

Reported by: carljm 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 carljm 6 years ago.
Backtick-quote PEP references in docs

Download all attachments as: .zip

Change History (5)

Changed 6 years ago by carljm

Backtick-quote PEP references in docs

comment:1 Changed 6 years ago by carljm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

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

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

comment:2 Changed 6 years ago by thejaswi_puthraya

  • Triage Stage changed from Unreviewed to Ready for checkin

comment:3 Changed 6 years ago by jacob

  • Resolution set to fixed
  • Status changed from new to closed

Fixed in [8552].

comment:4 Changed 3 years ago by jacob

  • milestone 1.0 deleted

Milestone 1.0 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.