From f930cd40b5e64b6d3d6d80b347b3236cb12c4837 Mon Sep 17 00:00:00 2001 From: Adam Porter Date: Sun, 9 Jun 2019 00:05:26 -0500 Subject: [PATCH] Docs: Tidy --- README.org | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.org b/README.org index 15af222..c247123 100644 --- a/README.org +++ b/README.org @@ -83,7 +83,7 @@ A query is a lisp form which may contain arbitrary lisp forms, as well as certai *** Predicates -Arguments are listed next to predicate names, when applicable. +Arguments are listed next to predicate names, where applicable. Note that, for convenience, standard numeric comparator function symbols (~<~, ~=~, etc.) do not need to be quoted when passed as an argument to these predicates. The resemblance to infix notation is coincidental. See examples in documentation. @@ -104,7 +104,6 @@ Note that, for convenience, standard numeric comparator function symbols (~<~, ~ + ~tags (&optional tags)~ :: Return non-nil if current heading has one or more of ~TAGS~ (a list of strings). + ~todo (&optional keywords)~ :: Return non-nil if current heading is a ~TODO~ item. With ~KEYWORDS~, return non-nil if its keyword is one of ~KEYWORDS~ (a list of strings). - ** Functions / Macros :PROPERTIES: :TOC: ignore-children @@ -272,7 +271,7 @@ Generates the predicate subtree. (defun org-ql--readme-predicate-list () "Return an Org list string documenting predicates." (concat (unpackaged/docstring-to-org - "Arguments are listed next to predicate names, when applicable. + "Arguments are listed next to predicate names, where applicable. Note that, for convenience, standard numeric comparator function symbols (`<', `=', etc.) do not need to be quoted when passed as an argument to these predicates. The resemblance to infix notation is coincidental. See examples in documentation.\n\n") (s-join "\n" (->> org-ql-predicates