Fix typo and clarify input file argument in Interpreter help message#4946
Open
Nokhrin wants to merge 1 commit into
Open
Fix typo and clarify input file argument in Interpreter help message#4946Nokhrin wants to merge 1 commit into
Nokhrin wants to merge 1 commit into
Conversation
- Fix typo in class name: 'Intrepreter' -> 'Interpreter' - Replace abstract 'input-filename(s)' with 'source-code-file(s)' to clarify that the tool expects plain text source code files, not compiled binaries. - Update the stdin fallback message to use the new terminology and replace the ambiguous word 'rig' with 'the tool'. Signed-off-by: Aleksandr Nokhrin <a.v.nokhrin@yandex.ru>
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
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.
Problem
The help message for
org.antlr.v4.gui.Interpreter(invoked viaantlr4-parseor directly viajava -cp) contains a typo in the class name (Intrepreter) and uses the abstract terminput-filename(s), which can be confusing for users trying to understand what kind of files the tool expects.Additionally, the fallback message uses the word "rig", which is ambiguous in this context.
Solution
This PR updates the help message printed to
stderrwhen the tool is invoked with insufficient arguments:Intrepreter→Interpreter.input-filename(s)withsource-code-file(s)to explicitly indicate that the tool expects plain text source code files in the target language.Before
After
Verification
Run the interpreter with insufficient arguments to trigger the help message:
The output should match the "After" block above.