documentation of hooks
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
`help` should probably add something automated about methods that have hooks associated to them. This shouldn't be too hard:
```m2
i1 : hooks(saturate, Ideal, Ideal)
o1 = {0 => (saturate, Ideal, Ideal, Strategy => Iterate) }
{1 => (saturate, Ideal, Ideal, Strategy => Eliminate)}
{2 => (saturate, Ideal, Ideal, Strategy => GRevLex) }
{3 => (saturate, Ideal, Ideal, Strategy => Monomial) }
o1 : NumberedVerticalList
i2 : toList \\ last \ last \ oo
o2 = {Iterate, Eliminate, GRevLex, Monomial}
```
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 locating the implementation of the help command and the hooks(saturate, Ideal, Ideal) example in the repository. Determine how help could expose methods with associated hooks, then verify that the resulting automated documentation includes the hook information shown by the example.
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
- Needs clarification
- Newbie friendliness
- 35/100