jackfirth / jackfirth/resyntax
Warn on undocumented exports
Open
Nobody has claimed this yet.
documentation
new lint
- Dominant language
- Racket
- Stars
- 70
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
TODO: more details
Notes:
- Only warn when at least one other export in the same module is documented
- Cannot suggest a fix, so this is a warn-only rule
Contributor guide
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 payload names no files, tests, or entry points. Start by locating the existing export-documentation analysis and comparable warning rules; done means warning only when another export in the module is documented, with no suggested fix.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100