[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/undo-fu-session fa62a9b9a1 03/53: Cleanup: messages & docs
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/undo-fu-session fa62a9b9a1 03/53: Cleanup: messages & docstrings |
Date: |
Thu, 7 Jul 2022 12:05:14 -0400 (EDT) |
branch: elpa/undo-fu-session
commit fa62a9b9a14a254b0dc9fb37ad351f3d731685ec
Author: Campbell Barton <ideasman42@gmail.com>
Commit: Campbell Barton <ideasman42@gmail.com>
Cleanup: messages & docstrings
---
undo-fu-session.el | 32 +++++++++++++++-----------------
1 file changed, 15 insertions(+), 17 deletions(-)
diff --git a/undo-fu-session.el b/undo-fu-session.el
index 958b91bb7e..744ce456bd 100644
--- a/undo-fu-session.el
+++ b/undo-fu-session.el
@@ -25,7 +25,7 @@
;;; Commentary:
-;; This extension provides a way to use undo history of
+;; This extension provides a way to use undo steps of
;; individual file buffers persistently.
;;
;; Write the following code to your .emacs:
@@ -43,12 +43,12 @@
;; Custom variables.
(defgroup undo-fu-session nil
- "Persistent undo history, stored on disk between sessions."
+ "Persistent undo steps, stored on disk between sessions."
:group 'convenience)
(defcustom undo-fu-session-directory
(locate-user-emacs-file "undo-fu-session" ".emacs-undo-fu-session")
- "A directory being stored undo history files."
+ "The directory to store undo data."
:group 'undo-fu-session
:type 'string)
@@ -63,7 +63,7 @@
:type '(repeat (choice regexp function)))
(defcustom undo-fu-session-incompatible-major-modes nil
- "List of major-modes in which saving undo history should not be performed."
+ "List of major-modes in which saving undo data should not be performed."
:type '(repeat symbol)
:group 'undo-fu-session)
@@ -74,12 +74,11 @@ Enforcing removes the oldest files."
:type 'integer
:group 'undo-fu-session)
-
;; ---------------------------------------------------------------------------
;; Undo Encode/Decode Functionality
(defun undo-fu-session--walk-tree (fn tree)
- "Operate recursively on undo history, calling FN TREE."
+ "Operate recursively on undo-list, calling FN TREE."
(cond
((consp tree)
(let ((value (funcall fn tree)))
@@ -134,7 +133,7 @@ Enforcing removes the oldest files."
tree))
(defun undo-fu-session--decode (tree)
- "Decode `TREE' so that it can be recovered as undo history."
+ "Decode `TREE' so that it can be recovered as undo data."
(undo-fu-session--walk-tree
(lambda (a)
(if (consp a)
@@ -163,7 +162,7 @@ Enforcing removes the oldest files."
tree))
(defun undo-fu-session--next-step (list)
- "Get the next undo step in the list.
+ "Get the next undo step in LIST.
Argument LIST compatible list `buffer-undo-list'."
(while (car list)
@@ -246,7 +245,6 @@ Argument PENDING-LIST an `pending-undo-list'. compatible
list."
(puthash key val equiv-table-hash)))))
equiv-table-hash))
-
;; ---------------------------------------------------------------------------
;; Undo Session Limiting Functionality
@@ -301,7 +299,7 @@ Argument PENDING-LIST an `pending-undo-list'. compatible
list."
(throw 'found t)))))
(defun undo-fu-session--recover-buffer-p (buffer)
- "Return t if undo history of BUFFER should be recovered."
+ "Return t if undo data of BUFFER should be recovered."
(let
(
(filename (buffer-file-name buffer))
@@ -373,10 +371,10 @@ Argument PENDING-LIST an `pending-undo-list'. compatible
list."
(when (bound-and-true-p undo-fu-session-mode)
(condition-case err
(undo-fu-session--save-impl)
- (error (message "Undo-Fu-Session can not save undo history: %s" err)))))
+ (error (message "Undo-Fu-Session can not save undo data: %s" err)))))
(defun undo-fu-session-save ()
- "Save undo history."
+ "Save undo data."
(interactive)
(undo-fu-session-save-safe))
@@ -410,11 +408,11 @@ Argument PENDING-LIST an `pending-undo-list'. compatible
list."
(setq content-header (read (current-buffer)))
(unless (eq (buffer-size buffer) (assoc-default 'buffer-size
content-header))
- (message "File length doesn't match, so undo history will be
discarded.")
+ (message "Undo-Fu-Session discarding undo data: file length
mismatch")
(throw 'exit nil))
(unless (string-equal (sha1 buffer) (assoc-default 'buffer-checksum
content-header))
- (message "File checksum doesn't match, so undo history will be
discarded.")
+ (message "Undo-Fu-Session discarding undo data: file checksum
mismatch")
(throw 'exit nil))
;; No errors... decode all undo data.
@@ -446,10 +444,10 @@ Argument PENDING-LIST an `pending-undo-list'. compatible
list."
(when (bound-and-true-p undo-fu-session-mode)
(condition-case err
(undo-fu-session--recover-impl)
- (error (message "Undo-Fu-Session can not recover undo history: %s"
err)))))
+ (error (message "Undo-Fu-Session can not recover undo data: %s" err)))))
(defun undo-fu-session-recover ()
- "Recover undo history."
+ "Recover undo data."
(interactive)
(undo-fu-session-recover-safe))
@@ -477,7 +475,7 @@ Argument PENDING-LIST an `pending-undo-list'. compatible
list."
;;;###autoload
(define-minor-mode undo-fu-session-mode
- "Toggle saving the undo history in the current buffer (Undo-Fu Session
Mode).."
+ "Toggle saving the undo data in the current buffer (Undo-Fu Session Mode)."
:global nil
(cond
- [nongnu] elpa/undo-fu-session 243d93b4c7 21/53: Cleanup: formatting, (continued)
- [nongnu] elpa/undo-fu-session 243d93b4c7 21/53: Cleanup: formatting, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session dae6dfbc7d 28/53: Cleanup: docstrings, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session a6a23301a4 30/53: Fix #2: resolve potential security issue with file permissions, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 7bbc89a42f 36/53: Build linear-list in-order instead of reversing, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 2fe1efcfa1 37/53: Shorten message, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 5862b90b9c 38/53: Cleanup: use file-name-concat for clarity, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 56d3134287 40/53: Cleanup: use simpler syntax to construct the overlay list, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 4330e87aac 50/53: Remove undo-fu-session hooks when no buffers have the mode enabled, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 3e54374b37 52/53: Cleanup: use double-dash for private functions, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session fa4833d470 02/53: readme: update to reference other packages, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session fa62a9b9a1 03/53: Cleanup: messages & docstrings,
ELPA Syncer <=
- [nongnu] elpa/undo-fu-session 049fe942f6 11/53: Cleanup: order buffer-undo-list before pending-undo-list, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 5cc4b4f33d 12/53: Fix for linearizing an empty undo-list disabling undo on reload, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 56cdd3538a 16/53: Don't show common-place messages in the echo area, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 5135b5cb61 15/53: Update changelog, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session a038914736 18/53: Update readme, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 191babe23c 24/53: Cleanup: docstring width warnings, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 00bc3807d7 25/53: Cleanup: replace 'if' with 'cond', ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 7c095e863c 26/53: Cleanup: remove redundant groups, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session cbe37c6643 31/53: Alternate fix for #2, make the directory only readable by the user, ELPA Syncer, 2022/07/07
- [nongnu] elpa/undo-fu-session 4605b0cc2b 33/53: Tests: simplify execution, with & without the linear option set, ELPA Syncer, 2022/07/07