Variable: flyspell-sort-corrections-function

flyspell-sort-corrections-function is a customizable variable defined in flyspell.el.gz.

Value

flyspell-sort-corrections-alphabetically

Documentation

The function used to sort corrections.

This only happens if flyspell-sort-corrections is non-nil. The function takes three parameters -- the two correction candidates to be sorted, and the third parameter is the word that's being corrected.

This variable was added, or its default value changed, in Emacs 26.1.

Probably introduced at or before Emacs version 26.1.

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/flyspell.el.gz
(defcustom flyspell-sort-corrections-function
  'flyspell-sort-corrections-alphabetically
  "The function used to sort corrections.
This only happens if `flyspell-sort-corrections' is non-nil.  The
function takes three parameters -- the two correction candidates
to be sorted, and the third parameter is the word that's being
corrected."
  :version "26.1"
  :type 'function)