links in documentation
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
Most automatically generated lists, other than the index, have entries such as:
```
"canonicalTruncation" -- see canonicalTruncation(Complex,ZZ,ZZ) -- reducing the number of non-zero terms of a complex
```
Better would be to convert the first string to a link taking you to the correct node, and omitting see clause (and keep the headline).
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
No file or test is named. Start by locating the generator for automatically generated documentation lists and compare its handling of the index with other lists. Done means entries such as canonicalTruncation link directly to the correct node, omit the “see” clause, and retain the headline.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100