[elpa] externals/popper c465e0de24 007/102: Added technical notes to README

[ELPA Syncer]

branch: externals/popper
commit c465e0de24412a115c6421fdaffd762a7fb44139
Author: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Commit: Karthik Chikmagalur <karthikchikmagalur@gmail.com>

    Added technical notes to README
---
 README.org | 5 +++++
 popper.el  | 3 ++-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.org b/README.org
index 2e355047a7..ba882072d6 100644
--- a/README.org
+++ b/README.org
@@ -113,3 +113,8 @@ In keeping with the principle of least surprise, all popups 
are shown in the sam
 
   (setq popper-display-control nil))
 #+end_src
+
+* Technical notes
+=popper= uses a buffer local variable (=popper-popup-status=) to identify if a 
given buffer should be treated as a popup. Matching is always by buffer and not 
window, so having two windows of a buffer, one treated as a popup and one as a 
regular window, isn't possible (although you can do this with indirect clones). 
In addition, it maintains an alist of popup windows/buffers for cycling through.
+
+By default, it installs a single rule in =display-buffer-alist= to handle 
displaying popups. If =popper-display-control= is set to =nil=, this rule is 
ignored. You can change how the popups are shown by customizing 
=popper-display-function=, the function used by =display-buffer= to display 
popups, although you are better off customizing =display-buffer-alist= directly 
or using Shackle. 
diff --git a/popper.el b/popper.el
index 6db3cd0785..c2590bec09 100644
--- a/popper.el
+++ b/popper.el
@@ -76,7 +76,8 @@ Example:
   help-mode
   compilation-mode)
 
-Will match against the Messages buffer, any buffer ending in Output*, and all 
help and compilation buffers."
+Will match against the Messages buffer, any buffer ending in
+Output*, and all help and compilation buffers."
   :type '(restricted-sexp :match-alternatives (stringp symbolp))
   :group 'popper)