branch: externals/org
commit 094ee4490d366bec3a8496fd609e175f12684c7e
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
org-attach-store-link-p: Explain all the values in the docstring
* lisp/org-attach.el (org-attach-store-link-p): Detail what each of
the allowed values mean, in addition to the :type tags.
---
lisp/org-attach.el | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/lisp/org-attach.el b/lisp/org-attach.el
index 6af8364fc7..8673ddd88d 100644
--- a/lisp/org-attach.el
+++ b/lisp/org-attach.el
@@ -139,7 +139,10 @@ Selective means to respect the inheritance setting in
(const :tag "Respect org-use-property-inheritance" selective)))
(defcustom org-attach-store-link-p nil
- "Non-nil means store a link to a file when attaching it."
+ "Non-nil means store a link to a file when attaching it.
+When t, store the link to original file location.
+When `file', store link to the attached file location.
+When `attached', store attach: link to the attached file."
:group 'org-attach
:version "24.1"
:type '(choice
