Crate whichdoc

Crate whichdoc 

Source
Expand description

A cargo documentation diagnostics-driven editor.

whichdoc uses ratatui to give a “diagnostics picker” list of cargo docs missing_docs errors, and edtui to emulate a vim editor in which to write your docstrings.

Modules§

app_state
The core state machine bridging the diagnostics and interactive editor.
config
Configuration to acknowledge developer preferences as well as set defaults.
edit_plan
The edit plan keeps a record of the contract between the interactive session and the file system
highlight
input
Parse the compiler’s diagnostic output (cargo doc diagnostics).
types
The types mirror cargo’s diagnostic (“message”) JSON format.
ui
The UI renders the application state into something visible and vim-able.