search

rust-lang / rust-mode

Emacs configuration for Rust
Apache License 2.0
1.1k stars 178 forks source link

Improve documentation #356

Closed ivnsch closed 2 years ago

ivnsch commented 4 years ago

What does exactly rust-mode do? It's unclear from reading the readme. A bullet list with features would be neat.

brotzeit commented 4 years ago

True. Any kind of help is very much appreciated.

holocircuit commented 4 years ago

I'm going to give this a go.

I think there are also some useful functions like rust-run and rust-clippy that aren't in the keymap, which makes them harder to find. I'll mention these, but it might be worth adding them to rust-mode-map as well. (After exploring this mode for a bit, I'll open a separate issue for that.)

holocircuit commented 4 years ago

I don't think I did an amazing job of this, but I added some details in https://github.com/rust-lang/rust-mode/pull/358. The main point I tried to make clear was that this package deals with things like Font Lock and indentation, but doesn't deal with auto-completion or jumping to definitions.

brotzeit commented 2 years ago

@holocircuit thanks