From c3e23c307292b03fba5f3996326ea71fce94c354 Mon Sep 17 00:00:00 2001 From: Adam Porter Date: Mon, 23 Nov 2020 04:52:01 -0600 Subject: [PATCH] Docs: Mention deprecated macro --- README.org | 6 ++++-- org-ql.info | 62 +++++++++++++++++++++++++++-------------------------- 2 files changed, 36 insertions(+), 32 deletions(-) diff --git a/README.org b/README.org index bfeda5d..15649ee 100644 --- a/README.org +++ b/README.org @@ -267,7 +267,7 @@ The following predicates, in addition to the keyword arguments, can also take a - [[#caching][Caching]] - [[#function-org-ql-select][Function: org-ql-select]] - [[#function-org-ql-query][Function: org-ql-query]] - - [[#macro-org-ql][Macro: org-ql]] + - [[#macro-org-ql-deprecated][Macro: org-ql (deprecated)]] - [[#custom-predicates][Custom predicates]] - [[#macro-org-ql-defpred][Macro: org-ql-defpred]] :END: @@ -403,12 +403,14 @@ Examples: ;; => ((headline (:raw-value "Visit the moon" ...) ...) ...) #+END_SRC -**** Macro: ~org-ql~ +**** Macro: ~org-ql~ (deprecated) /Arguments:/ ~(buffers-or-files query &key sort narrow markers action)~ Expands into a call to ~org-ql-select~ with the same arguments. For convenience, arguments should be unquoted. +/Note: This macro is deprecated and will be removed in v0.7./ + *** Custom predicates + See: [[file:examples/defpred.org][Custom predicate tutorial]] diff --git a/org-ql.info b/org-ql.info index bcc932e..bf5c7e5 100644 --- a/org-ql.info +++ b/org-ql.info @@ -736,7 +736,7 @@ File: README.info, Node: Listing / acting-on results, Next: Custom predicates, :where '(todo "WAITING")) ;; => ((headline (:raw-value "Visit the moon" ...) ...) ...) - 4. Macro: ‘org-ql’ + 4. Macro: ‘org-ql’ (deprecated) _Arguments:_ ‘(buffers-or-files query &key sort narrow markers action)’ @@ -744,6 +744,8 @@ File: README.info, Node: Listing / acting-on results, Next: Custom predicates, Expands into a call to ‘org-ql-select’ with the same arguments. For convenience, arguments should be unquoted. + _Note: This macro is deprecated and will be removed in v0.7._ +  File: README.info, Node: Custom predicates, Prev: Listing / acting-on results, Up: Functions / Macros @@ -1461,35 +1463,35 @@ Node: Date/time predicates17382 Node: Functions / Macros20037 Node: Agenda-like views20335 Node: Listing / acting-on results21740 -Node: Custom predicates27281 -Node: Dynamic block30772 -Node: Links33470 -Node: Tips34157 -Node: Changelog34475 -Node: 06-pre35171 -Node: 0535611 -Node: 04937088 -Node: 04837362 -Node: 04737709 -Node: 04638104 -Node: 04538504 -Node: 04438863 -Node: 04339220 -Node: 04239415 -Node: 04139576 -Node: 0439817 -Node: 03243750 -Node: 03144129 -Node: 0344326 -Node: 02347301 -Node: 02247529 -Node: 02147797 -Node: 0247996 -Node: 0152031 -Node: Notes52132 -Node: Comparison with Org Agenda searches52294 -Node: org-sidebar53166 -Node: License53445 +Node: Custom predicates27362 +Node: Dynamic block30853 +Node: Links33551 +Node: Tips34238 +Node: Changelog34556 +Node: 06-pre35252 +Node: 0535692 +Node: 04937169 +Node: 04837443 +Node: 04737790 +Node: 04638185 +Node: 04538585 +Node: 04438944 +Node: 04339301 +Node: 04239496 +Node: 04139657 +Node: 0439898 +Node: 03243831 +Node: 03144210 +Node: 0344407 +Node: 02347382 +Node: 02247610 +Node: 02147878 +Node: 0248077 +Node: 0152112 +Node: Notes52213 +Node: Comparison with Org Agenda searches52375 +Node: org-sidebar53247 +Node: License53526  End Tag Table