branch: externals/gnorb
commit 0cb4d1a83d5e0dc703d35941f4e3f24791225581
Author: Eric Abrahamsen <e...@ericabrahamsen.net>
Commit: Eric Abrahamsen <e...@ericabrahamsen.net>
Docstring for gnorb-scan-links
* lisp/gnorb-utils.el (gnorb-scan-links): Docstring
---
lisp/gnorb-utils.el | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/lisp/gnorb-utils.el b/lisp/gnorb-utils.el
index 52d5ced..b8bcd7a 100644
--- a/lisp/gnorb-utils.el
+++ b/lisp/gnorb-utils.el
@@ -238,6 +238,10 @@ If the KW argument is true, add the TODO keyword into the
path."
"\\3" (org-element-property :raw-value el)))))))))
(defun gnorb-scan-links (bound &rest types)
+ "Scan from point to BOUND looking for links of type in TYPES.
+
+TYPES is a list of symbols, possible values include 'bbdb, 'mail,
+and 'gnus."
;; this function could be refactored somewhat -- lots of code
;; repetition. It also should be a little faster for when we're
;; scanning for gnus links only, that's a little slow. We should
