Better detection of misplaced procedure declarations in sections#131
Merged
Conversation
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
1 participant
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 is clear about sections having either steps, or procedures, but not a mix of both. This is for good grammar reasons, but it is not particularly obvious to a new author. This branch improves the detection of a misplaced procedure declarations in a sections that already has steps, and produces a specific and helpful error message if encountered.
Then, quite unexpectedly, a single character error in a golden test added to the runner exposed a significant inconsistency in the way that results were tallied in the interactive mode versus the automatic mode. This led to a significant internal refactoring of the way that results are gathered as Output, and then conveyed upwards as Conclusions. The key to cleaning up the ambiguities was to give steps a Kind, whereby they can be identified as being neutral prose, having real-world effects, hinging on whether an automated runner can obtain their result or can only mark the step as skipped.