synonyms in the documentation
Open
Documentation
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
Synonyms should be automatically listed in the documentation. Half of synonyms are mentioned and half are not. If a synonym is meant as a backstop before deprecation, it should not be a synonym, but a method that prints a warning specifying the new name that should be used.
Contributor guide
No contributing guide indexed for this repository
Research direction
No files or tests are named. Start by locating where synonyms are defined and how documentation is generated, then compare the documented and undocumented sets; done means all synonyms are listed and any deprecation backstop identifies the new name in its warning.
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
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 42/100