branch: elpa/crux
commit 1c2c179de9f0292e6c7b602384aacb6ccbac6233
Author: Bozhidar Batsov <bozhi...@batsov.com>
Commit: Bozhidar Batsov <bozhi...@batsov.com>
Improve a docstring
---
crux.el | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/crux.el b/crux.el
index 59ded1e..eb36e8c 100644
--- a/crux.el
+++ b/crux.el
@@ -401,7 +401,10 @@ buffer is not visiting a file."
(crux-find-alternate-file-as-root buffer-file-name)))
(defun crux-reopen-as-root ()
- "Find file as root if necessary."
+ "Find file as root if necessary.
+
+Meant to be used as `find-file-hook'.
+See also `crux-reopen-as-root-mode'."
(unless (or (tramp-tramp-file-p buffer-file-name)
(equal major-mode 'dired-mode)
(not (file-exists-p (file-name-directory buffer-file-name)))
