Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 1.5 KB

features.md

File metadata and controls

24 lines (21 loc) · 1.5 KB

Implemented Features + Roadmap

  • Parse doc comments from arbitrary files
  • Decent error printing
  • cargo-spellcheck check
  • Spell checking using hunspell
  • Merge multiline doc comments
  • Handle multiline and fragmented mistakes (i.e. for grammar) #25
  • Grammar check using nlprule
  • Follow module declarations rather than blindly recurse
  • Be commonmark/markdown aware
    • Handle doc-tests with ```rust as virtual files #43
    • Verify all types of links #44
  • Check README.md files #37
  • Improve interactive user interface with crossterm
  • Ellipsize overly long statements with ... #42
  • Learn topic lingo and filter false-positive-suggestions #41
  • Handle cargo workspaces #38
  • Re-flow doc comments #39
  • Collect dev comments as well #115

hunspell (dictionary based lookups) and nlprules (static grammar rules, derived from languagetool) are currently the two supported checkers.