[elpa] externals/beframe 734ea942a1 3/5: RENAME assume/unassume commands that use multiple selection

[ELPA Syncer]

branch: externals/beframe
commit 734ea942a18eacbe0367d63ebc3050371b13c9c6
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    RENAME assume/unassume commands that use multiple selection
---
 README.org | 60 ++++++++++++++++++++++-----------------------
 beframe.el | 82 +++++++++++++++++++++++++++++++++++++++++---------------------
 2 files changed, 84 insertions(+), 58 deletions(-)

diff --git a/README.org b/README.org
index 182a5e74fa..4147c716e9 100644
--- a/README.org
+++ b/README.org
@@ -119,30 +119,30 @@ consolidated into new lists on demand.
 :CUSTOM_ID: h:dc12ca87-9ba7-4d11-89c8-653bf19015a1
 :END:
 
+[ Command that use ~completing-read-multiple~ are renamed as part of
+  {{{development-version}}}. ]
+
 To assume buffers is to include them in the buffer list associated
 with the current frame.
 
   #+findex: beframe-assume-frame-buffers
-  #+findex: beframe-add-frame-buffers
-- The command ~beframe-assume-frame-buffers~ (alias
-  ~beframe-add-frame-buffers~) prompts for a frame and then copies its
-  buffer list into the current frame.
-
-  #+findex: beframe-assume-buffers
-  #+findex: beframe-add-buffers
-- The command ~beframe-assume-buffers~ (alias ~beframe-add-buffers~)
-  adds buffers from a given frame to the current frame.  In
-  interactive use, the command first prompts for a frame and then asks
-  about the list of buffers therein.  The to-be-assumed buffer list is
-  compiled with ~completing-read-multiple~.  This means that the user
-  can select multiple buffers, each separated by the ~crm-separator~
-  (typically a comma).
-
-  #+findex: beframe-assume-buffers-all-frames
-- The command ~beframe-assume-buffers-all-frames~ prompts with
-  minibuffer completion for a list of buffers to assume.  The
-  interface is the same as that of ~beframe-assume-buffers~ except
-  that there is no prompt for a frame: buffers belong to the
+- The command ~beframe-assume-frame-buffers~ prompts for a frame and
+  then copies its buffer list into the current frame.
+
+  #+findex: beframe-assume-frame-buffers-selectively
+- The command ~beframe-assume-frame-buffers-selectively~ adds buffers
+  from a given frame to the current frame.  In interactive use, the
+  command first prompts for a frame and then asks about the list of
+  buffers therein.  The to-be-assumed buffer list is compiled with
+  ~completing-read-multiple~.  This means that the user can select
+  multiple buffers, each separated by the ~crm-separator~ (typically a
+  comma).
+
+  #+findex: beframe-assume-buffers-selectively-all-frames
+- The command ~beframe-assume-buffers-selectively-all-frames~ prompts
+  with minibuffer completion for a list of buffers to assume.  The
+  interface is the same as that of ~beframe-assume-frame-buffers-selectively~
+  except that there is no prompt for a frame: buffers belong to the
   consolidated buffer list (all frames).
 
   #+findex: beframe-assume-all-buffers-no-prompts
@@ -154,20 +154,20 @@ with the current frame.
 :CUSTOM_ID: h:8fb895ac-7f99-4c92-b15a-18871b30c7b9
 :END:
 
+[ Command that use ~completing-read-multiple~ are renamed as part of
+  {{{development-version}}}. ]
+
 To unassume buffers is to omit them from the buffer list associated with
 the current frame.
 
   #+findex: beframe-unassume-frame-buffers
-  #+findex: beframe-remove-frame-buffers
-- The command ~beframe-unassume-frame-buffers~ (alias
-  ~beframe-remove-frame-buffers~) prompts for a frame and then removes
-  its buffer list from the current frame.
-
-  #+findex: beframe-unassume-buffers
-  #+findex: beframe-remove-buffers
-- The command ~beframe-unassume-buffers~ (alias
-  ~beframe-remove-buffers~) removes buffers from the current frame.
-  In interactive use, the to-be-unassumed buffer list is compiled with
+- The command ~beframe-unassume-frame-buffers~ prompts for a frame and
+  then removes its buffer list from the current frame.
+
+  #+findex: beframe-unassume-frame-buffers-selectively
+- The command ~beframe-unassume-frame-buffers-selectively~ removes
+  buffers from the current frame.  In interactive use, the
+  to-be-unassumed buffer list is compiled with
   ~completing-read-multiple~.  This means that the user can select
   multiple buffers, each separated by the ~crm-separator~ (typically a
   comma).
diff --git a/beframe.el b/beframe.el
index 889aeaa9b5..1c7f105803 100644
--- a/beframe.el
+++ b/beframe.el
@@ -361,12 +361,15 @@ When called interactively, prompt for FRAME using 
completion.
 Else FRAME must satisfy `framep'.
 
 Also see `beframe-unassume-frame-buffers',
-`beframe-assume-buffers', `beframe-unassume-buffers'."
+`beframe-assume-frame-buffers-selectively',
+`beframe-unassume-frame-buffers-selectively'."
   (interactive (list (beframe--frame-object (beframe--frame-prompt))))
   (beframe--assume frame))
 
-(defalias 'beframe-add-frame-buffers 'beframe-assume-frame-buffers
-  "Alias of `beframe-assume-frame-buffers' command.")
+(make-obsolete
+ 'beframe-add-frame-buffers
+ 'beframe-assume-frame-buffers
+ "0.3.0")
 
 ;;;###autoload
 (defun beframe-unassume-frame-buffers (frame)
@@ -375,12 +378,15 @@ When called interactively, prompt for FRAME using 
completion.
 Else FRAME must satisfy `framep'.
 
 Also see `beframe-assume-frame-buffers',
-`beframe-assume-buffers', `beframe-unassume-buffers'."
+`beframe-assume-frame-buffers-selectively',
+`beframe-unassume-frame-buffers-selectively'."
   (interactive (list (beframe--frame-object (beframe--frame-prompt))))
   (beframe--unassume frame))
 
-(defalias 'beframe-remove-frame-buffers 'beframe-unassume-frame-buffers
-  "Alias of `beframe-unassume-frame-buffers' command.")
+(make-obsolete
+ 'beframe-remove-frame-buffers
+ 'beframe-unassume-frame-buffers
+ "0.3.0")
 
 (defun beframe--buffers-name-to-objects (buffers)
   "Convert list of named BUFFERS to their corresponding objects."
@@ -406,17 +412,22 @@ buffer list (buffers from all frames)."
    nil
    :require-match))
 
+(define-obsolete-function-alias
+  'beframe-assume-buffers
+  'beframe-assume-frame-buffers-selectively
+  "0.3.0")
+
 ;;;###autoload
-(defun beframe-assume-buffers (buffers)
-  "Assume BUFFERS from a frame into the current buffer list.
+(defun beframe-assume-frame-buffers-selectively (buffers)
+  "Assume BUFFERS from a selected frame into the current buffer list.
 
-In interactive use, BUFFERS is determined with a prompt that is
-powered by `completing-read-multiple'.  Multiple candidates can
-be selected, each separated by the `crm-separator' (typically a
-comma).
+In interactive use, select a frame and then use
+`completing-read-multiple' to pick the list of BUFFERS.  Multiple
+candidates can be selected, each separated by the
+`crm-separator' (typically a comma).
 
 Also see `beframe-assume-frame-buffers',
-`beframe-unassume-buffers', `beframe-unassume-frame-buffers'."
+`beframe-unassume-frame-buffers-selectively', 
`beframe-unassume-frame-buffers'."
   (interactive
    (list
     (beframe--buffers-name-to-objects
@@ -425,12 +436,19 @@ Also see `beframe-assume-frame-buffers',
        (beframe--frame-prompt))))))
   (beframe--assume buffers))
 
-(defalias 'beframe-add-buffers 'beframe-assume-buffers
-  "Alias of `beframe-assume-buffers' command.")
+(make-obsolete
+ 'beframe-add-buffers
+ 'beframe-assume-frame-buffers-selectively
+ "0.3.0")
+
+(define-obsolete-function-alias
+  'beframe-assume-buffers-all-frames
+  'beframe-assume-buffers-selectively-all-frames
+  "0.3.0")
 
 ;;;###autoload
-(defun beframe-assume-buffers-all-frames ()
-  "Like `beframe-assume-buffers' but for the consolidated buffer list (all 
frames)."
+(defun beframe-assume-buffers-selectively-all-frames ()
+  "Like `beframe-assume-frame-buffers-selectively' but for all frames."
   (declare (interactive-only t))
   (interactive)
   (beframe--assume
@@ -438,25 +456,33 @@ Also see `beframe-assume-frame-buffers',
     (beframe--buffer-list-prompt-crm
      :all-frames))))
 
+(define-obsolete-function-alias
+  'beframe-unassume-buffers
+  'beframe-unassume-frame-buffers-selectively
+  "0.3.0")
+
 ;;;###autoload
-(defun beframe-unassume-buffers (buffers)
+(defun beframe-unassume-frame-buffers-selectively (buffers)
   "Unassume BUFFERS from the current frame's buffer list.
 
-In interactive use, BUFFERS is determined with a prompt that is
-powered by `completing-read-multiple'.  Multiple candidates can
-be selected, each separated by the `crm-separator' (typically a
-comma).
+In interactive use, select a frame and then use
+`completing-read-multiple' to pick the list of BUFFERS.  Multiple
+candidates can be selected, each separated by the
+`crm-separator' (typically a comma).
 
 Also see `beframe-assume-frame-buffers',
-`beframe-assume-buffers', `beframe-unassume-frame-buffers'."
+`beframe-assume-frame-buffers-selectively',
+`beframe-unassume-frame-buffers'."
   (interactive
    (list
     (beframe--buffers-name-to-objects
      (beframe--buffer-list-prompt-crm))))
   (beframe--unassume buffers))
 
-(defalias 'beframe-remove-buffers 'beframe-unassume-buffers
-  "Alias of `beframe-unassume-buffers' command.")
+(make-obsolete
+ 'beframe-remove-buffers
+ 'beframe-unassume-frame-buffers-selectively
+ "0.3.0")
 
 ;;;###autoload
 (defun beframe-assume-all-buffers-no-prompts ()
@@ -483,11 +509,11 @@ Keep only the `beframe-global-buffers'."
   (let ((map (make-sparse-keymap)))
     (define-key map (kbd "b") #'beframe-switch-buffer)
     (define-key map (kbd "m") #'beframe-buffer-menu)
-    (define-key map (kbd "a f") #'beframe-assume-buffers)
+    (define-key map (kbd "a f") #'beframe-assume-frame-buffers-selectively)
     (define-key map (kbd "a F") #'beframe-assume-frame-buffers)
-    (define-key map (kbd "a a") #'beframe-assume-buffers-all-frames)
+    (define-key map (kbd "a a") 
#'beframe-assume-buffers-selectively-all-frames)
     (define-key map (kbd "a A") #'beframe-assume-all-buffers-no-prompts)
-    (define-key map (kbd "u f") #'beframe-unassume-buffers)
+    (define-key map (kbd "u f") #'beframe-unassume-frame-buffers-selectively)
     (define-key map (kbd "a F") #'beframe-unassume-frame-buffers)
     (define-key map (kbd "u U") #'beframe-unassume-all-buffers-no-prompts)
     map)