-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Fix in syntax.md. CSS adjustments #14747
Fix in syntax.md. CSS adjustments #14747
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that we have to update the highlight.pack.js
since it doesn't include support for ebnf
ATM. Though for some reason it includes OCaml
and Ruby
for example 🤔
Overall, I think that the change to styling is a big improvement 😄
highlight.js doesnt provide support to ebnf, there's only bnf supported |
Hmmm, there is some code that looks lik |
ef59d97
to
0443992
Compare
f9ce476
to
a60c4e7
Compare
I am afraid the change of semicolons completely butchered the grammar. The grammar is the core piece of specification. Every symbol counts. Please don't do wholesale changes like this without consulting more broadly. |
I find it very problematic that a PR pretending to be style fix can change a core piece of the specification and all docs without passing proper review. We have to review how we deal with PRs and how we can avoid such blunders in the future. |
I'll revert the commit for now, and re-open the issue. |
I see now that all the |
I think in general if it is a change that affects docs wholesale it has to be discussed in team with the authors of the docs. I find it very frustrating to see docs I spent many hours writing massacred like this. |
The highlight.js tool which we use to highlight the syntax, is not very sophisticated and uses basic regexes to consume grammars. The authors of EBNF highlighting added these semicolons in order to simplify rules and not use lookaheads etc. (You need to know when the rule ends to parse next token as a LHS of next rule) I'm sorry about this situation. I guess we can just replace the semicolons with some invisible unicode character or any other symbol that won't be misleading. |
closes #14697
@MarcinAman