Skip to content

Commit

Permalink
Fix some docstrings (#1902)
Browse files Browse the repository at this point in the history
* helm.el (helm-display-function): Do it.
(helm-split-window-default-fn):    Do it.
(helm-display-buffer):             Do it.
  • Loading branch information
thierryvolpiatto committed Oct 20, 2017
1 parent 41fc6d6 commit cdd9018
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions helm.el
Expand Up @@ -392,7 +392,7 @@ the default has changed now to avoid flickering."
(defcustom helm-display-function 'helm-default-display-buffer
"Function to display *helm* buffer.
By default, it is `helm-default-display-buffer', which affects
`helm-full-frame'."
`helm-full-frame' among others."
:group 'helm
:type 'symbol)

Expand Down Expand Up @@ -2479,6 +2479,14 @@ frame configuration as per `helm-save-configuration-functions'."
(select-frame-set-input-focus frame))))))

(defun helm-split-window-default-fn (window)
"Default function to split windows before displaying `helm-buffer'.
It is used as default value for
`helm-split-window-preferred-function' which is then the let-bounded
value of `split-window-preferred-function' in `helm-display-buffer'.
When `helm-display-function' which default to
`helm-default-display-buffer' is called from `helm-display-buffer' the
value of `split-window-preferred-function' will be used by `display-buffer'."
(let (split-width-threshold)
(if (and (fboundp 'window-in-direction)
;; Don't try to split when starting in a minibuffer
Expand Down Expand Up @@ -2519,7 +2527,10 @@ frame configuration as per `helm-save-configuration-functions'."
;;
(defun helm-display-buffer (buffer)
"Display BUFFER.
The function to display `helm-buffer'."
The function used to display `helm-buffer' by calling
`helm-display-function' which split window with
`helm-split-window-preferred-function'."
(let (pop-up-frames
(split-window-preferred-function
helm-split-window-preferred-function)
Expand Down

0 comments on commit cdd9018

Please sign in to comment.