grammarbot.el

This file is automatically generated from grammarbot.el by GitHub#ellit-org.el tool. Do not edit manually.

grammarbot.el is GNU Emacs interface to wonderful GrammarBot service.

grammarbot.el interface is similar to ispell. There is only one command M-x grammarbot RET to check either buffer or active region.

Customizable Options

You can customize grammarbot.el with M-x customize-group RET grammarbot RET using Emacs Easy Customization Interface

Or just tweak following user options in your init.el:

• User Option: grammarbot-language

  Language to use. Default value: “en-US”

  Please note that only English is supported at the moment (“en-US” or “en-GB”).

• User Option: grammarbot-show-stats, default: t

  Non-nil to show statistics for all found issues after check.

  Stats are shown in echo area with message like:

  Grammarbot issues: 2, ignored: 1, replaced: 1
      

• User Option: grammarbot-api-key

  Your API Key obtained from http://grammarbot.io.

• User Option: grammarbot-accept-single-choice-rules

  List of rules for issues to automatically accept single choice replacement.

  Consider we are checking next sentence with grammarbot.el:

  However it is wise to automatically accept single replacements
      

  While checking, *Grammarbot Choices* buffer pops up for the issue:

  Did you forget a comma after a conjunctive/linking adverb?
  Rule: (:id "SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA" :subId "1" :description "Commas after conjunctive/linking adverbs in front of a new sentence." :issueType "typographical" :urls [(:value "https://writing.wisc.edu/Handbook/ConjAdv.html")] :category (:id "PUNCTUATION" :name "Punctuation"))
  
  (0) However,
      

  As you can see, issue has single replacement - “However,”. For single replacement issues corresponding issue rule is shown.

  You can customize grammarbot-accept-single-choice-rules to automatically accept such issue and do the auto-replacement. To do so, add:

  (add-to-list 'grammarbot-accept-single-choice-rules
  	     '(:issueType "typographical" :category (:id "PUNCTUATION")))
      

• User Option: grammarbot-ignore-single-choice-rules

  List of rules for issues to automatically ignore single choice replacement.

  Elements of the list are in same format as fors grammarbot-accept-single-choice-rules.

  By default “Whitespace repetition” and “Sentence starts with an uppercase letter” issues are ignored.