[CDRIVER-976] man pages have stray "\&" Created: 30/Oct/15  Updated: 10/Aug/16  Resolved: 26/Apr/16

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.4.0

Type: Bug Priority: Minor - P4
Reporter: A. Jesse Jiryu Davis Assignee: A. Jesse Jiryu Davis
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to CDRIVER-967 basic-troubleshooting manpage not ren... Closed

 Description   

When a Mallard page includes a paragraph ending like:

something</code>.</p>

It is rendered in a man page like:

something \&.

The offending line is this:

https://github.com/mongodb/mongo-c-driver/blob/1.2.0/doc/mallard2man.py#L117



 Comments   
Comment by Githook User [ 26/Apr/16 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: mallard2man fixes

CDRIVER-976 stray ampersands in man pages, and CDRIVER-967, badly
rendered bullet points, and CDRIVER-1077 rename error-api.3 to
mongoc-error-api.3.

Silence warnings about <info>, <steps>, <desc>, <links>, and <thead>
elements. Handle <example>. Remove extra indentation from paragraphs,
and fix rendering of titles that contain double quotes.
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/d71d82bf5a79bf4b0e12cd5171302e04d499d291

Generated at Wed Feb 07 21:11:11 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.