Skip to content

Commit df4ba5a

Browse files
committed
Update commentary.
1 parent 5b45fc6 commit df4ba5a

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

ivy-file-preview.el

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,17 @@
2727

2828
;;; Commentary:
2929
;;
30-
;; Preview the current ivy file selection.
30+
;; This global minor mode enhanced the user experience while controlling
31+
;; through `ivy' interface during some previewable commands.
32+
;;
33+
;; You can enable this minor mode by doing the following execution,
34+
;;
35+
;; `(ivy-file-preview-mode 1)`
36+
;;
37+
;; Some previewable commands can be a file, path, or search restult.
38+
;; The file and path can be either absolute/relative file path. The
39+
;; search result accepts cons cell for either (line . column) or a
40+
;; integer (position).
3141
;;
3242

3343
;;; Code:

0 commit comments

Comments
 (0)