LaTeX macros for individual package documentation
Open
Nobody has claimed this yet.
Core
Documentation
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
It would be great if each package could define its own macros for documentation. Currently these are the default:
https://github.com/Macaulay2/M2/blob/11396850f9d3bbe84aae00dfdb0f77093e93c89e/M2/Macaulay2/m2/html.m2#L22-L29
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 by reading the default macro definitions in M2/Macaulay2/m2/html.m2 at lines 22-29 and trace how package documentation uses them. Determine where package-specific definitions could be supplied and how they would be selected. Done means individual packages can define documentation macros without changing the defaults.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100