[elpa] externals/beframe 9895696a21 02/10: Simplify the package Commentary

[ELPA Syncer]

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

    Simplify the package Commentary
---
 beframe.el | 108 ++-----------------------------------------------------------
 1 file changed, 2 insertions(+), 106 deletions(-)

diff --git a/beframe.el b/beframe.el
index d22ffe02e5..e13fde3af5 100644
--- a/beframe.el
+++ b/beframe.el
@@ -29,113 +29,9 @@
 ;; `beframe' enables a frame-oriented Emacs workflow where each frame
 ;; has access to the list of buffers visited therein.  In the interest
 ;; of brevity, we call buffers that belong to frames "beframed".
-;; Beframing is achieved in three main ways:
 ;;
-;; 1. By calling the command `beframe-switch-buffer'.  It is like the
-;;    standard `switch-to-buffer' except the list of candidates is
-;;    limited to those that the current frame knows about.
-;;
-;; 2. By enabling the global minor mode `beframe-mode'.  It sets the
-;;    `read-buffer-function' to one that filters buffers per frame.  As
-;;    such, commands like `switch-to-buffer', `next-buffer', and
-;;    `previous-buffer' automatically work in a beframed way.
-;;
-;; 3. The command `beframe-buffer-menu' produces a dedicated buffer with
-;;    a list of buffers for the current frame.  This is the counterpart
-;;    of `beframe-switch-buffer'.  When called with a prefix argument
-;;    (`C-u' with default key bindings), it prompts for a frame whose
-;;    buffers it will display.
-;;
-;; Producing multiple frames does not generate multiple buffer lists.
-;; There still is only one global list of buffers.  Beframing them simply
-;; filters the list.
-;;
-;; The user option `beframe-global-buffers' contains a list of strings
-;; that represent buffers names.  Those buffers are never beframed and
-;; are available in all frames.  The default value contains the buffers
-;; `*scratch*', `*Messages*', and `*Backtrace*'.
-;;
-;; The user option `beframe-create-frame-scratch-buffer' allows
-;; `beframe-mode' to create a frame-specific scratch buffer that runs
-;; the `initial-major-mode'.  This is done upon the creation of a new
-;; frame and the scratch buffer is named after the frame it belongs
-;; to.  For example, if the frame is called `modus-themes', the
-;; corresponding scratch buffer is `*scratch for modus-themes*'.  Set
-;; this user option to `nil' to disable the creation of such scratch
-;; buffers.
-;;
-;; The user option `beframe-kill-frame-scratch-buffer' is the
-;; counterpart of `beframe-create-frame-scratch-buffer'.  It kills the
-;; frame-specific scratch buffer after the frame is deleted.  Set this
-;; user option to `nil' to disable the killing of such 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.
-;;
-;; 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.
-;;
-;; 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).
-;;
-;; 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
-;; `completing-read-multiple'.  This means that the user can select
-;; multiple buffers, each separated by the `crm-separator' (typically a
-;; comma).
-;;
-;; The `beframe-mode' does the following:
-;;
-;; - Sets the value of `read-buffer-function' to a function that
-;;   beframes all commands that read that variable.  This includes the
-;;   likes of `switch-to-buffer', `next-buffer', and `previous-buffer'.
-;;
-;; - Add a filter to newly created frames so that their
-;;   `buffer-predicate' parameter beframes buffers.
-;;
-;; - Renames newly created frames so that they have a potentially more
-;;   meaningful title.  The user option `beframe-rename-function'
-;;   specifies the function that handles this process.  When its value
-;;   is nil, no renaming is performed.
-;;
-;; - When the user option `beframe-functions-in-frames' contains a list
-;;   of functions, it makes them run with `other-frame-prefix', meaning
-;;   that they are called in a new frame.  The default value of that
-;;   user option affects the `project.el' project-switching selection:
-;;   the new project buffer appears in its own frame and, thus, becomes
-;;   part of a beframed list of buffers, isolated from all other frames.
-;;
-;; - Handles the creation and deletion of frame-specific scratch
-;;   buffers,per the user options `beframe-create-frame-scratch-buffer',
-;;   `beframe-kill-frame-scratch-buffer'.
-;;
-;; Development note: `beframe' is in its early days.  The minor mode may
-;; be revised to have more features and/or greater flexibility.
-;;
-;; The `consult' package by Daniel Mendler (also known as @minad)
-;; provides commands that extend the functionality of the generic
-;; minibuffer.  Among them is `consult-buffer'.  With that command the
-;; user can search for buffers, recent files, and bookmarks, among
-;; others.
-;;
-;; `consult-buffer' displays a global list of buffers and is never
-;; beframed.  This is done by design.  Instead of forcing it to only show
-;; beframed buffers, we get the best of both worlds: (i) a convenient way
-;; to access the global list of buffers and (ii) a new entry to the
-;; `consult-buffer-sources' that registers beframed buffers as their own
-;; group.  Users can narrow directly to this group by typing `F' followed
-;; by `SPC'.
-;;
-;; Backronym: Buffers Encapsulated in Frames Realise Advanced
-;; Management of Emacs.
+;; Read the official manual for detailed documentation:
+;; <https://protesilaos.com/emacs/beframe>.
 
 ;;; Code: