Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move Changes file to a parsable text format #7875

Open
vicuna opened this issue Nov 24, 2018 · 3 comments

Comments

Projects
None yet
1 participant
@vicuna
Copy link

commented Nov 24, 2018

Original bug ID: 7875
Reporter: 0xc0
Status: new
Resolution: open
Priority: low
Severity: text
Category: documentation
Monitored by: @nojb

Bug description

The 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 information

The 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).

@vicuna

This comment has been minimized.

Copy link
Author

commented Nov 24, 2018

Comment author: @nojb

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

Do you have a suggestion how to semantically differentiate '-' and '*'?

@vicuna

This comment has been minimized.

Copy link
Author

commented Nov 24, 2018

Comment author: @nojb

What about using strong emphasis (**) to highlight the list items currently marked with '*' ?

@vicuna

This comment has been minimized.

Copy link
Author

commented Nov 24, 2018

Comment author: 0xc0

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.