branch: elpa/dirvish
commit 1bc2f93a9dc12a5a5a72b13fbb3ed9374a3b2ab7
Author: Nicolas Graves <76450848+nicolas-gra...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>
docs: document the nil case for dirvish-default-layout. (#231)
---
dirvish.el | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/dirvish.el b/dirvish.el
index 4a8f739511..f53ffc1b09 100644
--- a/dirvish.el
+++ b/dirvish.el
@@ -80,7 +80,10 @@ Credit: copied from `consult-preview-variables' in
`consult.el'."
(defcustom dirvish-default-layout '(1 0.11 0.55)
"Default layout recipe for fullscreen Dirvish sessions.
-The value has the form (DEPTH MAX-PARENT-WIDTH PREVIEW-WIDTH).
+The value has the form (DEPTH MAX-PARENT-WIDTH PREVIEW-WIDTH),
+if not nil. Neither the parent windows or the preview windows are
+shown if the value is nil.
+
DEPTH controls the number of windows displaying parent
directories. It can be 0 if you don't need the parent
directories. MAX-PARENT-WIDTH controls the max width allocated
@@ -88,9 +91,11 @@ to each parent windows. PREVIEW-WIDTH controls the width
allocated to preview window. The default value provides a
1:3:5 (approximately) pane ratio. Also see
`dirvish-layout-recipes' in `dirvish-extras.el'."
- :group 'dirvish :type '(list (integer :tag "number of parent windows")
- (float :tag "max width of parent windows")
- (float :tag "width of preview windows")))
+ :group 'dirvish
+ :type '(choice (const :tag "no default layout" nil)
+ (list (integer :tag "number of parent windows")
+ (float :tag "max width of parent windows")
+ (float :tag "width of preview windows"))))
(defface dirvish-hl-line
'((t :inherit highlight :extend t))
