diff options
| author | Nicholas Hubbard <nicholashubbard@posteo.net> | 2022-03-10 14:31:42 -0500 |
|---|---|---|
| committer | Nicholas Hubbard <nicholashubbard@posteo.net> | 2022-03-10 14:31:42 -0500 |
| commit | 8820ca6f9ae65d6d652e5b10e1b5bbbb7329610f (patch) | |
| tree | 5cca4b5979c24885220182abeb2dd2cd88b949cc | |
| parent | 3b6f0cd5efd255805a51b384a3483e34c04e9be9 (diff) | |
Document persp--state-complete-v2.
| -rw-r--r-- | perspective.el | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/perspective.el b/perspective.el index 8619d42..546689f 100644 --- a/perspective.el +++ b/perspective.el @@ -1682,6 +1682,7 @@ PERSP-SET-IDO-BUFFERS)." files frames) +;; Keep around old version to maintain backwards compatibility. (cl-defstruct persp--state-frame persps order) @@ -1696,9 +1697,9 @@ PERSP-SET-IDO-BUFFERS)." windows) (defun persp--state-complete-v2 (state-complete) - "Return a persp--state-complete struct based off of STATE-COMPLETE that is -guarenteed to be compatible with perspective state version 2 which supports -saving perspective merge lists." + "Apply this function to persp--state-complete structs to be guarenteed a +persp--state-complete that is compatible with merge-list saving. Useful for +maintaining backwards compatibility." (let* ((state-frames (persp--state-complete-frames state-complete)) (state-frames-v2 (mapcar (lambda (state-frame) |