Create a script to simplify the language specification#4340
Merged
Conversation
chloestefantsova
approved these changes
Apr 28, 2025
Contributor
chloestefantsova
left a comment
chloestefantsova
left a comment
There was a problem hiding this comment.
LGTM with a few nits.
Member
Author
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.