Skip to content

Commit

Permalink
Change: (org-ql) Declare macro obsolete
Browse files Browse the repository at this point in the history
  • Loading branch information
alphapapa committed Nov 23, 2020
1 parent 56a0820 commit 90f712a
Show file tree
Hide file tree
Showing 4 changed files with 252 additions and 242 deletions.
3 changes: 3 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,9 @@ Simple links may also be written manually in either sexp or non-sexp form, like:
*Internal*
+ When formatting entries for Org QL View buffers, use internal function for retrieving heading tags. This improves speed by using our cache, and it removes the need for a compatibility alias for Org versions before 9.3.

*Deprecated*
+ Macro =org-ql= is marked obsolete. It will be removed in v0.7. Functions =org-ql-select= and =org-ql-query= should be used instead. (The macro serves only to confuse with regard to quoting arguments.)

*Acknowledgments*
+ [[https://github.com/tpeacock19][tpeacock19]] for extensive help testing new features in this version.

Expand Down
4 changes: 2 additions & 2 deletions org-ql.el
Original file line number Diff line number Diff line change
Expand Up @@ -184,12 +184,12 @@ match."
(push (list :name ',pred-name :aliases ',aliases :fn ',fn-name :docstring ,docstring :args ',args) org-ql-predicates))
(cl-defun ,fn-name ,args ,docstring ,@body))))

;; TODO: Mark as obsolete/deprecated.
;;;###autoload
(cl-defmacro org-ql (buffers-or-files query &key sort narrow action)
"Expands into a call to `org-ql-select' with the same arguments.
For convenience, arguments should be unquoted."
(declare (indent defun))
(declare (indent defun)
(obsolete "Please use functions `org-ql-select' or `org-ql-query' instead" "org-ql 0.5"))
`(org-ql-select ,buffers-or-files
',query
:action ',action
Expand Down
50 changes: 28 additions & 22 deletions org-ql.info
Original file line number Diff line number Diff line change
Expand Up @@ -882,6 +882,12 @@ File: README.info, Node: 05-pre, Next: 049, Up: Changelog
our cache, and it removes the need for a compatibility alias for
Org versions before 9.3.

*Deprecated*
• Macro org-ql is marked obsolete. It will be removed in v0.7.
Functions org-ql-select and org-ql-query should be used instead.
(The macro serves only to confuse with regard to quoting
arguments.)

*Acknowledgments*
• tpeacock19 (https://github.com/tpeacock19) for extensive help
testing new features in this version.
Expand Down Expand Up @@ -1357,28 +1363,28 @@ Node: Links29556
Node: Tips30243
Node: Changelog30561
Node: 05-pre31245
Node: 04932484
Node: 04832762
Node: 04733109
Node: 04633504
Node: 04533904
Node: 04434263
Node: 04334620
Node: 04234815
Node: 04134974
Node: 0435215
Node: 03239148
Node: 03139527
Node: 0339724
Node: 02342699
Node: 02242927
Node: 02143195
Node: 0243394
Node: 0147429
Node: Notes47530
Node: Comparison with Org Agenda searches47692
Node: org-sidebar48564
Node: License48843
Node: 04932719
Node: 04832997
Node: 04733344
Node: 04633739
Node: 04534139
Node: 04434498
Node: 04334855
Node: 04235050
Node: 04135209
Node: 0435450
Node: 03239383
Node: 03139762
Node: 0339959
Node: 02342934
Node: 02243162
Node: 02143430
Node: 0243629
Node: 0147664
Node: Notes47765
Node: Comparison with Org Agenda searches47927
Node: org-sidebar48799
Node: License49078

End Tag Table

Expand Down
Loading

0 comments on commit 90f712a

Please sign in to comment.