Bazaar

Documentation markup bugs

Bug #746237 reported by Thomi Richards
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Bazaar
Fix Released
High
Martin Pool

Bug Description

There are several markup bugs in the Bazaar documentation. For instance, on this page:

http://doc.bazaar.canonical.com/latest/en/user-reference/conflict-types-help.html

The first bullet point is rendered as a literal block, and many of the subsequent literal blocks are surrounded by "``", which is used in reST to indicate an inline literal.

Tags: doc

Related branches

lp:~mbp/bzr/doc
Jelmer Vernooij (community): Approve
Andrew Bennetts: Pending requested
Diff: 13 lines (+4/-0)
1 file modified
doc/developers/contribution-quickstart.txt (+4/-0)
Andrew Bennetts (spiv)
tags: added: doc
Changed in bzr:
importance: Undecided → High
status: New → Confirmed
Martin Pool (mbp)
Changed in bzr:
assignee: nobody → Martin Pool (mbp)
status: Confirmed → In Progress
Revision history for this message
Martin Pool (mbp) wrote :

Thanks, I have a fix committed for this particular thing. If you find others, please let us know: the markup system interprets sees what we have there as correct, so we don't get a warning.

The one other case I know of is in the rendering of the format options in eg <http://doc.bazaar.canonical.com/latest/en/user-reference/init-help.html>.

Revision history for this message
Martin Pool (mbp) wrote :

... which is a bit hard to fix because rest doesn't really expect options to include dots, it seems. Perhaps we should now just not give short options for those formats. They're very old.

Revision history for this message
John A Meinel (jameinel) wrote :

Is this currently just stalled because of the '.' in options breaking sphinx? Should we be knocking it down from In Progress because we've fixed as much as we can for now?

Revision history for this message
Martin Pool (mbp) wrote : Re: [Bug 746237] Re: Documentation markup bugs

Let's have a separate bug for that: bug 772186.

  status fixreleased

Changed in bzr:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.