Documentation of the overall language
Open
@MichaelABurr is already working on this.
Since May 15, 2020.
Documentation
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
@michaelaburr - Michael Burr suggests additional introductory material about the Macaulay2 language be added to the documentation to make it easier for newcomers, especially for those knowing C:
- an introductory section about the overall syntactical structure of the language
- everything is an expression, there are no statements
- list processing is important; there are also hash tables
- the class hierarchy is present and important
- method functions versus compiled functions
- classes don't own methods, methods for binary operators are stored in the youngest type
- all objects are on an equal footing (everything has a hash code and can be used
as a key in a hash table) (everything has a class and a parent) - some operators are mathematical and some are oriented toward low-level tasks
- in the section on classes
- how to explore existing objects in the system (peek, peek')
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.
Assessment
This issue has not been assessed yet.