killercup / killercup/rust-docstrings
Fuzzy matching (and suggestions?)
- Dominant language
- Rust
- Stars
- 12
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Add a mode to fuzzy match headlines with a list of known headlines (see [this post](https://deterministic.space/machine-readable-inline-markdown-code-cocumentation.html) for a proposal) and suggest fixes for close matches.
Something like this `Suggestion { found: "Example", suggested: "Examples", … }`. (Fields tracking span data etc omitted. Should give enough details to be usable by clippy.)
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading the linked proposal and reviewing the rust-docstrings project to determine how known headlines and clippy diagnostics should be represented. Define the fuzzy-matching mode and a usable Suggestion result, including the omitted span-tracking fields, then verify that close matches produce actionable fixes for clippy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100