Skip to content
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

Document containing the language specification #308

Open
cstffx opened this issue Feb 24, 2020 — with GitSpeak · 3 comments
Open

Document containing the language specification #308

cstffx opened this issue Feb 24, 2020 — with GitSpeak · 3 comments
Labels
v2

Comments

Copy link

@cstffx cstffx commented Feb 24, 2020 — with GitSpeak

Description

Work in a language specification document.

Why

Keeping up with new features and syntax changes is complicated due to lack of documentation. But everything is easier if each feature is documented in a document that contains a formal description of the language. This could also be useful for those who wish to improve or implement pending features that involve the compiler.

It is a reference document for anyone who wishes to write quality documentation.

Is this something you're interested in working on?

Yes

@cstffx cstffx changed the title A language specification Document containing the language specification Feb 24, 2020
@somebee somebee added the v2 label Feb 25, 2020 — with GitSpeak
Copy link
Member

@aalemayhu aalemayhu commented Feb 25, 2020 — with GitSpeak

I love the idea but I am not sure how much overhead this could potentially add. Do you have a concrete example? Were you thinking something in the direction of GROQ https://sanity-io.github.io/GROQ/

Thanks.

@cstffx
Copy link
Author

@cstffx cstffx commented Feb 25, 2020

Yes. I was using as a reference in my mind the ecma-262 and you proposal is very similar. Seems that we can use spec-md

@aalemayhu
Copy link
Member

@aalemayhu aalemayhu commented Apr 15, 2020

I tried replying over email but it looks like I have some setup issues.

Anyways, I was trying to write that it would be cool if we could generate this spec-md from the grammar and rewriter file.

https://github.com/imba/imba/blob/master/src/compiler/grammar.imba1
https://github.com/imba/imba/blob/master/src/compiler/rewriter.imba1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.