Added ebnf.md file #1987
Open
Added ebnf.md file #1987
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
amitu
reviewed
Oct 18, 2024
| <item> ::= <comment> | <section> | ||
|
|
||
|
|
||
| <module_comment> ::= (<single_module_comment> <new_line>)* <single_module_comment> (<new_line> | <eof>) |
There was a problem hiding this comment.
Suggested change
| <module_comment> ::= (<single_module_comment> <new_line>)* <single_module_comment> (<new_line> | <eof>) | |
| <module_comment> ::= (<single_module_comment> <new_line>)* (<single_module_comment> <eof>)? |
Would this be same / simpler?
Would this work?
Suggested change
| <module_comment> ::= (<single_module_comment> <new_line>)* <single_module_comment> (<new_line> | <eof>) | |
| <module_comment> ::= (<single_module_comment> (<new_line> | <eof>))* |
amitu
reviewed
Oct 18, 2024
|
|
||
|
|
||
| <module_comment> ::= (<single_module_comment> <new_line>)* <single_module_comment> (<new_line> | <eof>) | ||
| <single_module_comment> ::= <doc_comment_marker> <opt_whitespace> <sentence>? <opt_whitespace> |
There was a problem hiding this comment.
Suggested change
| <single_module_comment> ::= <doc_comment_marker> <opt_whitespace> <sentence>? <opt_whitespace> | |
| <single_module_comment> ::= <doc_comment_marker> <space>* <sentence>? <space>* |
Should we have opt_whitespace?
There was a problem hiding this comment.
Should we include the <newline> | <eof> here only? And rename this to <module_comment_line>?
amitu
reviewed
Oct 18, 2024
|
|
||
|
|
||
|
|
||
| <start_marker> ::= "--" |
There was a problem hiding this comment.
Let's rename this to section_start_marker. Should we include the space here itself as that is required part of our syntax we just discussed?
There was a problem hiding this comment.
Also I think the grammar would be easier to read if we do not define names for things that are ever used once.
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.
No description provided.