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

Documentation for the interpreter #2247

Open
mahrud opened this issue Oct 2, 2021 · 0 comments
Open

Documentation for the interpreter #2247

mahrud opened this issue Oct 2, 2021 · 0 comments

Comments

@mahrud
Copy link
Member

mahrud commented Oct 2, 2021

Macaulay2 packages are decently documented, the Core has documentation (except everything in #1668), and the engine has some documentation. As far as I'm aware the interpreter code in the d/ directory and the translator in the c/ directory have no documentation. Not only that, since the language is made up, there's no external way to learn the language. Needless to say, this is a problem that will only get worse if it isn't documented.

There are now M2internals meeting notes about the language itself, and a few aspects of the interpreter, but what should be the preferred way to document the sources in the interpreter?

Ideally, I wish there was a roadmap for cleaning up that directory and documenting it along the way.

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

No branches or pull requests

1 participant