Skip to content

Create a script to simplify the language specification #4340

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

Open
wants to merge 64 commits into
base: main
Choose a base branch
from

Conversation

eernstg
Copy link
Member

@eernstg eernstg commented Apr 27, 2025

The language specification uses semantic line breaks and rather short lines. This means that it gets somewhat inconvenient to search in a number of situations. For example, we may find the command \Error{compile-time error} on one line and the text that describes which error it is on the next line. Also, when searching the language specification for hard facts it may create some noise that a rather large portion of the language specification is commentary, rationale, and comments.

This PR adds a small script that processes the language specification such that it is more convenient to search for hard facts: It removes comments, commentary, and rationale, and it joins paragraphs written as several lines into a single line. This terse version of the language specification can be created by invoking make terse.

Copy link
Contributor

@chloestefantsova chloestefantsova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a few nits.

@eernstg
Copy link
Member Author

eernstg commented Apr 28, 2025

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants