search

emacs-languagetool / flymake-languagetool

Flymake support for LanguageTool
GNU General Public License v3.0
33 stars 11 forks source link

flymake-mode not started using snippet in README #21

Closed jcubic closed 6 months ago

jcubic commented 6 months ago

The documentation doesn't say that you need to run:

(flymake-mode)

It seems the mode is not enabled by default when calling (flymake-languagetool-load)

jcs090218 commented 6 months ago

Yes, you will still need to enable flymake-mode after (flymake-language-tool-load). Flymake is the frontend and can work with multiple checkers so it wasn't included as a part of the documentation.

I'm no longer an Emacs beginner, so I don't know what documentation is required. PRs for improving documentation are always welcome. :)

tpeacock19 commented 6 months ago

Even though step 4 explicitly says to call flymake-mode, the following step is offered as an alternative without any mention of the mode.

I'll update readme to be a bit clearer.

jcubic commented 6 months ago

I think that the best Emacs documentation is when you have code snippet that you copy paste into your .emacs and it just works. Right now when you add code from README it will not work. You need to have another code that is not shown that triggers the flymake-mode. The same is with flycheck version.

If you say that you need to call flymake-mode if someone is not that familiar with elisp he will not know how to do that. I personally use manual installation using hooks, I would have no idea how to add two functions calls from use-package because I never used it before.

tpeacock19 commented 6 months ago

I understand the desire to have a snippet you can copy and paste. However, I won't be adding any calls to flymake-mode in the snippets since it is a minor-mode and the expectation is if someone is installing a diagnostic for flymake they know how to enable it. For more information on flymake, how it is enabled, and other functionality I suggest reading the info (C-h i) documentation.