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

Tidy: (org-ql-defpred) Docstring

Browse source 
This does not solve the compilation warning, because that's caused by
the Pcase patterns at the end of the docstring, which the linter
falsely identifies as incorrect.
This commit is contained in:
Adam Porter 2024-06-12 23:08:54 -05:00
parent f7c3a61e32
commit e9d08ca344
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
org-ql.el
View file

@ -1141,7 +1141,7 @@ defined in `org-ql-predicates' by calling `org-ql-defpred'."
(byte-compile 'org-ql--query-preamble))) (byte-compile 'org-ql--query-preamble)))
(cl-defmacro org-ql-defpred (name args docstring &key body preambles normalizers coalesce) (cl-defmacro org-ql-defpred (name args docstring &key body preambles normalizers coalesce)
"Define an \\+`org-ql' selector predicate \\=`org-ql--predicate-NAME'. "Define an Org QL selector predicate `org-ql--predicate-NAME'.
NAME may be a symbol or a list of symbols: if a list, the first NAME may be a symbol or a list of symbols: if a list, the first
is used as NAME and the rest are aliases. A function is only is used as NAME and the rest are aliases. A function is only
created for NAME, not for aliases, so a normalizer should be used created for NAME, not for aliases, so a normalizer should be used
@ -1226,7 +1226,7 @@ Then if NORMALIZERS were:
It would be expanded to: It would be expanded to:
((\\=`(,(or 'heading 'h) . ,args) ((\\=`(,(or \\='heading \\='h) . ,args)
\\=`(heading ,@args)))" \\=`(heading ,@args)))"
;; FIXME: Update defpred tutorial to include :coalesce. ;; FIXME: Update defpred tutorial to include :coalesce.