Skip to content

Commit

Permalink
Tidy: (org-ql-defpred) Docstring
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
alphapapa committed Jun 13, 2024
1 parent f7c3a61 commit e9d08ca
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions org-ql.el
Original file line number Diff line number Diff line change
Expand Up @@ -1141,7 +1141,7 @@ defined in `org-ql-predicates' by calling `org-ql-defpred'."
(byte-compile 'org-ql--query-preamble)))

(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
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
Expand Down Expand Up @@ -1226,7 +1226,7 @@ Then if NORMALIZERS were:
It would be expanded to:
((\\=`(,(or 'heading 'h) . ,args)
((\\=`(,(or \\='heading \\='h) . ,args)
\\=`(heading ,@args)))"
;; FIXME: Update defpred tutorial to include :coalesce.

Expand Down

0 comments on commit e9d08ca

Please sign in to comment.