Documentation of creating types
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
In the documentation node for "[Type](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Macaulay2Doc/html/___Type.html)", there is literally zero mention of "[new](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Macaulay2Doc/html/_new.html)", which is the only way to create a type!
I'd say this should be listed under "Functions and methods returning a type", but `new` isn't really a function or method. Still, maybe we should change it so exceptional language syntax features can be listed there? Maybe `NewOfMethod` and friends should be listed there, but displayed the way we would use them?
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 Type documentation node and the linked new documentation page. Determine how type-creation syntax should be presented, including whether new or related constructs belong under “Functions and methods returning a type.” Done means the Type documentation explains how to create a type and clearly links or describes the relevant syntax.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100