Opened 12 years ago

Closed 11 years ago

#1748 closed defect (fixed)

ReStructuredText errors don't stand out from HTML documentation

Reported by: Antti Kaihola Owned by: Jacob
Component: Documentation Version:
Severity: normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description (last modified by Adrian Holovaty)

Every now and then a ReStructuredText syntax error creeps into the documentation. Errors are hard to spot since they look exactly like the body text. Maybe a red border or some other visual effect would help catch them.

A new rule could go into the Django site style sheet:

div.system-message { border: solid red 2px; padding: 1em; }

Change History (1)

comment:1 Changed 11 years ago by Adrian Holovaty

Description: modified (diff)
Resolution: fixed
Status: newclosed

We've fixed the ReST errors and have a better system for spotting them now as the docs are built, so I'm closing this ticket.

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