variables, symbols, identifiers conventions in the documentation
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
The following do not reflect reality:
* https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Macaulay2Doc/html/_variables.html
currently says
> Valid names for symbols may be constructed using letters, digits, and the apostrophe, and should not begin with a digit.
* https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Macaulay2Doc/html/___Symbol.html
> Symbols are entered as an alphabetic character followed by a sequence of alphanumeric characters; case is significant. The single symbol character ' is regarded as alphabetic, so that symbols such as x' may be used.
The reality is reflected by:
https://github.com/Macaulay2/M2/blob/c6aff10750a8b8a7e221f04c72d3d8b90c902ea9/M2/Macaulay2/d/ctype.d#L69
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
Compare the statements in the variables.html and ___Symbol.html documentation pages with the naming rules shown at M2/Macaulay2/d/ctype.d#L69. Update both descriptions so they match the implementation, then verify that the documented conventions accurately reflect the accepted variable and symbol names.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100