From 0f48ea9725de0598dcf4e313b238cf7b372cc510 Mon Sep 17 00:00:00 2001
From: Justin Barclay <git@justinbarclay.ca>
Date: Mon, 4 Nov 2024 18:08:44 -0800
Subject: [PATCH] chore: add documentation on error reporting with flycheck and
 flymake

---
 readme.org | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/readme.org b/readme.org
index be6ffa3..09833b9 100644
--- a/readme.org
+++ b/readme.org
@@ -220,6 +220,21 @@ Options:
   #+begin_quote
   default: safe
   #+end_quote
+** Error reporting
+parinfer-rust-mode uses flycheck and flymake to report parsing errors.
+*** Flymake
+There should be no config needed to work in ==flymake-mode== is enabled.
+*** Flycheck
+parinfer-rust-mode is set-up to be chained with the ==emacs-lisp== checker.
+
+However, if you want it to work alongside other checkers you'll need to [[https://www.flycheck.org/en/latest/user/syntax-checkers.html#configuring-checker-chains][chain]] it yourself.
+#+begin_src emacs-lisp
+  (use-package parinfer-rust-mode
+    :config
+    (flycheck-add-next-checker 'emacs-lisp 'parinfer-rust t))
+#+end_src
+*** Message buffer
+If neither Flycheck or Flymake are enabled then ==parinfer-rust-mode== will output the error to ==*Messages*== buffer.
 ** parinfer-mode
    There is an alternate implementation of Parinfer for Emacs called [[https://github.com/DogLooksGood/parinfer-mode][parinfer-mode]]. It currently has support for Parinfer's "paren" and "indent". Additionally, it has had experimental support for "smart" mode, however, this has remained hidden on a branch and not accessible from MELPA for over a year.
    parinfer-smart-mode aims to be a simpler adaptation of Parinfer that just offers "smart mode", leveraging the parinfer-rust plugin to do most of the heavy lifting.