Documentation for the interpreter
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the M2internals meeting notes and inspect the undocumented interpreter sources in d/ and translator sources in c/. The issue asks for a preferred documentation approach and a roadmap, but does not name specific files or define a completion criterion.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100