From 88ba3d3933ede18f5e48e4463e4d58bf9d981b11 Mon Sep 17 00:00:00 2001 From: Adam Porter Date: Sun, 21 Jul 2019 17:21:17 -0500 Subject: [PATCH] Docs: (org-ql) Improve docstring --- README.org | 2 ++ org-ql.el | 3 +++ 2 files changed, 5 insertions(+) diff --git a/README.org b/README.org index 91ca0dc..7d1cdd0 100644 --- a/README.org +++ b/README.org @@ -218,6 +218,8 @@ If ~NARROW~ is non-nil, buffers are not widened. Find entries in ~BUFFERS-OR-FILES~ that match ~QUERY~, and return the results of running ~ACTION-FN~ on each matching entry. +Unlike the corresponding function ~org-ql-query~, arguments to this macro should not be quoted. + ~BUFFERS-OR-FILES~ is a form which should evaluate to one (or a list of) file(s) or buffer(s). ~QUERY~ is an ~org-ql~ query sexp, unquoted. diff --git a/org-ql.el b/org-ql.el index debed89..39f9221 100644 --- a/org-ql.el +++ b/org-ql.el @@ -95,6 +95,9 @@ match." (action '(org-element-headline-parser (line-end-position)))) "Find entries in BUFFERS-OR-FILES that match QUERY, and return the results of running ACTION-FN on each matching entry. +Unlike the corresponding function `org-ql-query', arguments to +this macro should not be quoted. + BUFFERS-OR-FILES is a form which should evaluate to one (or a list of) file(s) or buffer(s).