Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0007875OCamldocumentationpublic2018-11-24 07:122018-11-24 19:18
Reporter0xc0 
Assigned To 
PrioritylowSeveritytextReproducibilityN/A
StatusnewResolutionopen 
PlatformOSOS Version
Product Version 
Target VersionFixed in Version 
Summary0007875: move Changes file to a parsable text format
DescriptionThe Changes file is currently over 8000 lines, with the first 700 lines devoted to working changes. Because this file is currently in just a text format, there is scrolling and/or text search required to see changes of even recently released versions.

By moving to a parsable format such as AsciiDoc or Markdown, editors which already have support for parsing such a format can outline and collapse the structure of this file.

Additionally, such a change can give the ocaml source code root directory a slightly more modern feel than a plain text file.
Additional InformationThe file is already parsable as a Markdown file, with the exception that there is a semantic distinction between a bulleted item beginning with "-" and a bulleted item beginning with "*" (Markdown treats these as equivalent).
TagsNo tags attached.
Attached Files

- Relationships

-  Notes
(0019480)
nojebar (developer)
2018-11-24 07:52

Would adding the `.md` extension suffice as a first step?

Do you have a suggestion how to semantically differentiate '-' and '*'?
(0019481)
nojebar (developer)
2018-11-24 08:09

What about using strong emphasis (**) to highlight the list items currently marked with '*' ?
(0019482)
0xc0 (reporter)
2018-11-24 19:18

Yes, `.md` extension and adding strong emphasis (**) would be great.

Some of the asterisks within the text would need to be escaped or put into inline code.

- Issue History
Date Modified Username Field Change
2018-11-24 07:12 0xc0 New Issue
2018-11-24 07:52 nojebar Note Added: 0019480
2018-11-24 08:09 nojebar Note Added: 0019481
2018-11-24 19:18 0xc0 Note Added: 0019482


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker