Skip to content

Commit 4da768e

Browse files
committed
Improve the commentary
1 parent f1e7267 commit 4da768e

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

flycheck-rust.el

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,20 @@
2525

2626
;;; Commentary:
2727

28-
;; Improve Rust support in Flycheck by configuring Flycheck automatically in
29-
;; Cargo projects.
30-
31-
;;;; Setup
32-
33-
;; (add-hook 'flycheck-mode-hook #'flycheck-rust-setup)
28+
;; This Flycheck extension configures Flycheck automatically for the current
29+
;; Cargo project.
30+
;;
31+
;; # Setup
32+
;;
33+
;; (add-hook 'flycheck-mode-hook #'flycheck-rust-setup)
34+
;;
35+
;; # Usage
36+
;;
37+
;; Just use Flycheck as usual in your Rust/Cargo projects.
38+
;;
39+
;; Note: You must run `cargo build` initially to install all dependencies. If
40+
;; you add new dependencies to `Cargo.toml` you need to run `cargo build`
41+
;; again. Otherwise you will see spurious errors about missing crates.
3442

3543
;;; Code:
3644

0 commit comments

Comments
 (0)