Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion for docs  #22

Open
sinauq opened this issue Nov 28, 2023 · 1 comment
Open

Suggestion for docs  #22

sinauq opened this issue Nov 28, 2023 · 1 comment
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@sinauq
Copy link

sinauq commented Nov 28, 2023

What version of Emacs are you running?

29.1

What version of LanguageTool are you running?

remote server

What version of this package are you running?

1.3

What is the current behaviour?

The document is not clear about how to use languagetool's premium server.

What is you expect to happen?

For anyone who might face the same problem, the config should be something like this:

(use-package languagetool
  :config
  (setq
   languagetool-server-url "https://api.languagetoolplus.com"
   languagetool-server-port 443
   languagetool-api-key "XXXX"
   languagetool-username "XXX"
   ))


### What do you do to get this bug?

_No response_
@sinauq sinauq added the bug Something isn't working label Nov 28, 2023
@PillFall PillFall self-assigned this Dec 1, 2023
@PillFall PillFall added the documentation Improvements or additions to documentation label Dec 1, 2023
@PillFall
Copy link
Owner

PillFall commented Dec 1, 2023

Hi, I'm sorry you are experiencing this. Right now I do not have any way to test against premium LT, that's the main reason why the docs are so poor.

If you wanna help me improving the docs, I would appreciate it.

The only info referring to LT Plus are these lines in the ReadMe

languagetool.el/ReadMe.org

Lines 141 to 147 in b136d53

If you pay for [[https://languagetool.org/proofreading-api][LanguageTool Proofreading API]] features, you can add the keys for
the LanguageTool API as follows:
#+BEGIN_SRC elisp
(setq languagetool-api-key "xxxxxxxxxxxx"
languagetool-username "[email protected]")
#+END_SRC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants