Docs: org-ql, org-ql-query

Also rename org-ql--query to org-ql-query.
This commit is contained in:
Adam Porter 2019-06-08 04:24:50 -05:00
parent fc5647aea3
commit 4d186d7054
2 changed files with 33 additions and 3 deletions

View file

@ -58,7 +58,7 @@ This list should not contain any duplicates.")
ACTION is a sexp which will be evaluated at each matching entry
with point at the beginning of its heading. It is passed to
`org-ql--query' as a lambda. By default, `org-element-headline-parser'
`org-ql-query' as a lambda. By default, `org-element-headline-parser'
is called to return an Org element.
SORT is a user defined sorting function, or an unquoted list of
@ -81,7 +81,7 @@ buffer. In this case, ACTION should return an Org element."
;; maybe this should be on the agenda-ng side.
(->> ,action
org-ql--add-markers)))))
`(org-ql--query ,buffers-or-files
`(org-ql-query ,buffers-or-files
',pred-body
:action ,action
:narrow ,narrow
@ -98,7 +98,7 @@ buffer. In this case, ACTION should return an Org element."
;;;; Functions
(cl-defun org-ql--query (buffers-or-files query &key action narrow sort)
(cl-defun org-ql-query (buffers-or-files query &key action narrow sort)
"Return items matching QUERY in BUFFERS-OR-FILES.
QUERY is an `org-ql' query sexp.