[nongnu] elpa/flymake-pyrefly 416f580745a 8/8: Merge pull request #27 from inpefess/fix-doc

[ELPA Syncer]

branch: elpa/flymake-pyrefly
commit 416f580745acacc1bf51986f2aff92af6bb1dd00
Merge: 484e0d07d0e f04dcbe5eaa
Author: Boris Shminke <1696493+inpef...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>

    Merge pull request #27 from inpefess/fix-doc
    
    Doc fix
---
 README.org         |  6 ++++--
 flymake-pyrefly.el | 21 ++++++++++++++++-----
 2 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/README.org b/README.org
index 8b77e92bf48..6e154257895 100644
--- a/README.org
+++ b/README.org
@@ -1,8 +1,10 @@
+[[https://elpa.nongnu.org/nongnu/flymake-pyrefly.html][https://elpa.nongnu.org/nongnu/flymake-pyrefly.svg]]
+
 * flymake-pyrefly
 
 [[https://pyrefly.org/][Pyrefly]] is a fast Python type checker written in 
Rust.
 flymake-pyrefly is a Pyrefly backend for 
[[https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html#Top][Flymake]]
 that helps you to
-see typing errors in your Pyton files.
+see typing errors in your Python files.
 
 * How to install
 
@@ -20,7 +22,7 @@ Python files (notice the difference if you use eglot):
     :hook (python-base-mode . pyrefly-setup-flymake-backend))
 
   ;; or if you use eglot
-  (add-hook 'eglot-managed-mode-hook #'pyrefly-setup-flymake-backen)
+  (add-hook 'eglot-managed-mode-hook #'pyrefly-setup-flymake-backend)
 
   ;; if you use eglot and use-package
   (use-package flymake-pyrefly
diff --git a/flymake-pyrefly.el b/flymake-pyrefly.el
index d0dd8d04c59..2337e527531 100644
--- a/flymake-pyrefly.el
+++ b/flymake-pyrefly.el
@@ -5,7 +5,7 @@
 ;; Author: Boris Shminke <bo...@shminke.com>
 ;; Maintainer: Boris Shminke <bo...@shminke.com>
 ;; Created: 29 Jun 2025
-;; Version: 0.1.5
+;; Version: 0.1.6
 ;; Keywords: tools, languages
 ;; URL: https://github.com/inpefess/flymake-pyrefly
 ;; Package-Requires: ((emacs "26.1"))
@@ -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.