killercup / killercup/rust-docstrings

Fuzzy matching (and suggestions?)

Ouverte
#4 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement help wanted
Langage dominant
Rust
Étoiles
12
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

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.)

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
rust
Domaine
devtools
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.