Clarify accepted value for list of files in :scope

This commit is contained in:
Ihor Radchenko 2021-10-04 15:00:46 +08:00
parent 773fd9c01e
commit 888876594b
No known key found for this signature in database
GPG key ID: 6470762A7DA11D8B

View file

@ -248,7 +248,7 @@ Valid parameters include:
`buffer' the current buffer `buffer' the current buffer
`org-agenda-files' all agenda files `org-agenda-files' all agenda files
`org-directory' all org files `org-directory' all org files
`(list-of-files ...)' a list of org files `(\"path\" ...)' list of buffer names or file paths
`all' all agenda files, and org-mode buffers `all' all agenda files, and org-mode buffers
:query An Org QL query expression in either sexp or string :query An Org QL query expression in either sexp or string
@ -287,7 +287,7 @@ For example, an org-ql dynamic block header could look like:
(org-ql--ask-unsafe-query query) (org-ql--ask-unsafe-query query)
query))) query)))
(columns (or columns '(heading todo (priority "P")))) (columns (or columns '(heading todo (priority "P"))))
(scope (cond ((listp scope) scope) (scope (cond ((and (listp scope) (seq-every-p #'stringp scope)) scope)
((string-equal scope "org-agenda-files") (org-agenda-files)) ((string-equal scope "org-agenda-files") (org-agenda-files))
((or (not scope) (string-equal scope "buffer")) (current-buffer)) ((or (not scope) (string-equal scope "buffer")) (current-buffer))
((string-equal scope "org-directory") (org-ql-search-directories-files)) ((string-equal scope "org-directory") (org-ql-search-directories-files))