branch: elpa/flymake-pyrefly
commit c0e9862fd00514b536174b9f2cf04375bf773b88
Author: Boris Shminke <bo...@shminke.com>
Commit: Boris Shminke <bo...@shminke.com>
more doc and typo fix
---
flymake-pyrefly.el | 19 +++++++++++++++----
1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/flymake-pyrefly.el b/flymake-pyrefly.el
index d0dd8d04c59..df0dbcbb21a 100644
--- a/flymake-pyrefly.el
+++ b/flymake-pyrefly.el
@@ -27,13 +27,24 @@
;;; Commentary:
-;; A Pyrefly (https://pyrefly.org/) Flymake backend.
-;; Based on the annotated example from Flymake info.
+;; Pyrefly (https://pyrefly.org/) is a fast Python type checker
+;; written in Rust. flymake-pyrefly is a Pyrefly backend for Flymake
+;; that helps you to see typing errors in your Python files.
;;
;; Usage:
;;
+;; (add-hook 'python-base-mode-hook #'pyrefly-setup-flymake-backend)
+;;
+;; ;; alternatively, with use-package
+;; (use-package flymake-pyrefly
+;; :hook (python-base-mode . pyrefly-setup-flymake-backend))
+;;
+;; ;; or if you use eglot
+;; (add-hook 'eglot-managed-mode-hook #'pyrefly-setup-flymake-backend)
+;;
+;; ;; if you use eglot and use-package
;; (use-package flymake-pyrefly
-;; :hook (python-mode . pyrefly-setup-flymake-backend))
+;; :hook (eglot-managed-mode . pyrefly-setup-flymake-backend))
;;; Code:
(require 'cl-lib)
@@ -116,7 +127,7 @@
msg)
into diags
finally (funcall report-fn diags)))
- (flymake-log :warning "Canceling obsolete check %s"
+ (flymake-log :warning "Cancelling obsolete check %s"
proc))
;; Cleanup the temporary buffer used to hold the
;; check's output.
