jiri/org-ql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: (org-ql) Improve docstring

Browse source
This commit is contained in:
Adam Porter 2019-07-21 17:21:17 -05:00
parent 3133c4f33b
commit 88ba3d3933
2 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.org
View file

@ -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. 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). ~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. ~QUERY~ is an ~org-ql~ query sexp, unquoted.

3
org-ql.el
View file

@ -95,6 +95,9 @@ match."
(action '(org-element-headline-parser (line-end-position)))) (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. "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 BUFFERS-OR-FILES is a form which should evaluate to one (or a
list of) file(s) or buffer(s). list of) file(s) or buffer(s).