From 4eb4fb4ad49a1196778a7cf9fa00d9019a5a703d Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Fri, 8 Sep 2023 16:47:33 +0200 Subject: [PATCH] Mark two flyspell functions as internal * lisp/textmodes/flyspell.el: Minor doc fix. (flyspell--mode-on, flyspell--mode-off): Rename from 'flyspell-mode-on' and 'flyspell-mode-off'. The old names are preserved as obsolete aliases. --- lisp/textmodes/flyspell.el | 37 +++++++++++++------------------------ 1 file changed, 13 insertions(+), 24 deletions(-) diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index bcd3fb3f5da..1ca508e14ef 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el @@ -1,6 +1,6 @@ ;;; flyspell.el --- On-the-fly spell checker -*- lexical-binding:t -*- -;; Copyright (C) 1998, 2000-2023 Free Software Foundation, Inc. +;; Copyright (C) 1998-2023 Free Software Foundation, Inc. ;; Author: Manuel Serrano ;; Maintainer: emacs-devel@gnu.org @@ -22,7 +22,7 @@ ;; along with GNU Emacs. If not, see . ;;; Commentary: -;; + ;; Flyspell is a minor Emacs mode performing on-the-fly spelling ;; checking. ;; @@ -33,8 +33,7 @@ ;; M-x flyspell-prog-mode. ;; In that mode only text inside comments and strings is checked. ;; -;; Some user variables control the behavior of flyspell. They are -;; those defined under the `User configuration' comment. +;; Use `M-x customize-group RET flyspell RET' to customize flyspell. ;;; Code: @@ -517,10 +516,10 @@ in your init file. :group 'flyspell (if flyspell-mode (condition-case err - (flyspell-mode-on (called-interactively-p 'interactive)) + (flyspell--mode-on (called-interactively-p 'interactive)) (error (message "Error enabling Flyspell mode:\n%s" (cdr err)) (flyspell-mode -1))) - (flyspell-mode-off))) + (flyspell--mode-off))) ;;;###autoload (defun turn-on-flyspell () @@ -585,14 +584,14 @@ in your init file. (kill-local-variable 'flyspell-word-cache-word)))) ;; Make sure we flush our caches when needed. Do it here rather than in -;; flyspell-mode-on, since flyspell-region may be used without ever turning +;; flyspell--mode-on, since flyspell-region may be used without ever turning ;; on flyspell-mode. (add-hook 'ispell-kill-ispell-hook 'flyspell-kill-ispell-hook) ;;*---------------------------------------------------------------------*/ -;;* flyspell-mode-on ... */ +;;* flyspell--mode-on ... */ ;;*---------------------------------------------------------------------*/ -(defun flyspell-mode-on (&optional show-msg) +(defun flyspell--mode-on (&optional show-msg) "Turn Flyspell mode on. Do not use this; use `flyspell-mode' instead. If optional argument SHOW-MSG is non-nil, show a welcome message @@ -600,7 +599,6 @@ if `flyspell-issue-message-flag' and `flyspell-issue-welcome-flag' are both non-nil." (ispell-set-spellchecker-params) ; Initialize variables and dicts alists (setq ispell-highlight-face 'flyspell-incorrect) - ;; local dictionaries setup (or ispell-local-dictionary ispell-dictionary (if flyspell-default-dictionary (ispell-change-dictionary flyspell-default-dictionary))) @@ -610,24 +608,16 @@ are both non-nil." ;; Pass the `force' argument for the case where flyspell was active already ;; but the buffer's local-defs have been edited. (flyspell-accept-buffer-local-defs 'force) - ;; we put the `flyspell-delayed' property on some commands (flyspell-delay-commands) - ;; we put the `flyspell-deplacement' property on some commands (flyspell-deplacement-commands) - ;; we bound flyspell action to post-command hook (add-hook 'post-command-hook (function flyspell-post-command-hook) t t) - ;; we bound flyspell action to pre-command hook (add-hook 'pre-command-hook (function flyspell-pre-command-hook) t t) - ;; we bound flyspell action to after-change hook (add-hook 'after-change-functions 'flyspell-after-change-function nil t) - ;; we bound flyspell action to hack-local-variables-hook (add-hook 'hack-local-variables-hook (function flyspell-hack-local-variables-hook) t t) - ;; set flyspell-generic-check-word-predicate based on the major mode (let ((mode-predicate (get major-mode 'flyspell-mode-predicate))) (if mode-predicate (setq flyspell-generic-check-word-predicate mode-predicate))) - ;; the welcome message (if (and flyspell-issue-message-flag flyspell-issue-welcome-flag show-msg) @@ -714,23 +704,19 @@ has been used, the current word is not checked." (setq flyspell-pre-column (current-column))) ;;*---------------------------------------------------------------------*/ -;;* flyspell-mode-off ... */ +;;* flyspell--mode-off ... */ ;;*---------------------------------------------------------------------*/ ;;;###autoload -(defun flyspell-mode-off () +(defun flyspell--mode-off () "Turn Flyspell mode off." - ;; We remove the hooks. (remove-hook 'post-command-hook (function flyspell-post-command-hook) t) (remove-hook 'pre-command-hook (function flyspell-pre-command-hook) t) (remove-hook 'after-change-functions 'flyspell-after-change-function t) (remove-hook 'hack-local-variables-hook (function flyspell-hack-local-variables-hook) t) - ;; We remove all the flyspell highlightings. (flyspell-delete-all-overlays) - ;; We have to erase pre cache variables. (setq flyspell-pre-buffer nil) (setq flyspell-pre-point nil) - ;; We mark the mode as killed. (setq flyspell-mode nil)) ;;*---------------------------------------------------------------------*/ @@ -2369,6 +2355,9 @@ This function is meant to be added to `flyspell-incorrect-hook'." (defun flyspell-change-abbrev (table old new) (set (abbrev-symbol old table) new)) +(define-obsolete-function-alias 'flyspell-mode-on 'flyspell--mode-on "30.1") +(define-obsolete-function-alias 'flyspell-mode-off 'flyspell--mode-off "30.1") + (provide 'flyspell) ;;; flyspell.el ends here -- 2.39.5