Request: Link to source code from documentation
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
Hello,
Is it possible for the documentation to link to where the function(s) are defined in the github source code. I'm trying to figure out how some methods are implemented but it is very difficult to find where various functions are defined even when I can find the docs on the functions.
Thanks!
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
The issue mentions documentation pages and function definitions in the GitHub source, but names no files, documentation generator, or entry points. First identify how Macaulay2 documentation is generated and where function pages are assembled; done would mean the relevant documentation links each function to its source definition and the documentation checks pass.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100