/rust-api-docs-helper

Atom.io plugin that opens the rust standard library docs for 'use std::' statements

Primary LanguageCoffeeScriptMIT LicenseMIT

rust-api-docs-helper package

demo

What this package can do

  • Opening (via key binding) the docs for a module, crate, trait, function or struct from the official crates listed under The Rust Standard Library (the cursor must be positioned in the corresponding use xxx::xxx line).
  • Scans .rs files for imports and adds a clickable icon in the gutter in the lines docs are available for.
  • Can display the docs within atom if an internal browser (e.g. mark-hahn/web-browser) is installed.

Future plans

  • Make cache persistent between sessions (won't work until atom/atom#3695 is fixed).