the `gfanInterface` package runs `gfan` too early
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
The real problem is that the `gfanInterface` package runs `gfan` to capture the documentation for `gfan` so it can be inserted into its own documentation. A lot of that is useless for the user, such as the meaning of various options to `gfan`.
- insert the documentation into the code, deleting the tidbits about command line options
- omit it entirely
_Originally posted by @DanGrayson in https://github.com/Macaulay2/M2/pull/1253#issuecomment-641561853_
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 gfanInterface package and locating where it runs gfan to capture documentation. Determine whether the project prefers embedding edited documentation or omitting it, then make that choice explicit by removing the command-line option details or the generated documentation. Done means gfan is no longer run too early and the package documentation contains only useful user-facing material.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100