Docs: (priority) Update docstring
Fixes #81. Thanks to Ihor Radchenko (@yantar92).
This commit is contained in:
parent
2e0d38daae
commit
b00949d945
2 changed files with 28 additions and 26 deletions
|
|
@ -192,7 +192,7 @@ Arguments are listed next to predicate names, where applicable.
|
||||||
+ =outline-path-segment (&rest strings)= :: Return non-nil if current node's outline path matches ~STRINGS~. Matches ~STRINGS~ as a contiguous segment of the outline path. Each string is compared as a substring. For example the path ~Food/Fruits/Grapes~ would match ~(olps "Fruit" "Grape")~ but not ~(olps "Food" "Grape")~.
|
+ =outline-path-segment (&rest strings)= :: Return non-nil if current node's outline path matches ~STRINGS~. Matches ~STRINGS~ as a contiguous segment of the outline path. Each string is compared as a substring. For example the path ~Food/Fruits/Grapes~ would match ~(olps "Fruit" "Grape")~ but not ~(olps "Food" "Grape")~.
|
||||||
- Aliases: ~olps~.
|
- Aliases: ~olps~.
|
||||||
+ =path (&rest regexps)= :: Return non-nil if current heading's buffer's filename path matches any of ~REGEXPS~ (regexp strings). Without arguments, return non-nil if buffer is file-backed.
|
+ =path (&rest regexps)= :: Return non-nil if current heading's buffer's filename path matches any of ~REGEXPS~ (regexp strings). Without arguments, return non-nil if buffer is file-backed.
|
||||||
+ =priority (&optional comparator-or-priority priority)= :: Return non-nil if current heading has a certain priority. ~COMPARATOR-OR-PRIORITY~ should be either a comparator function, like ~<=~, or a priority string, like "A" (in which case (~=~ will be the comparator). If ~COMPARATOR-OR-PRIORITY~ is a comparator, ~PRIORITY~ should be a priority string. If both arguments are nil, return non-nil if heading has any defined priority.
|
+ =priority (&rest args)= :: Return non-nil if current heading has a certain priority. ~ARGS~ may be either a list of one or more priority letters as strings, or a comparator function symbol followed by a priority letter string. For example: ~(priority "A") (priority "A" "B") (priority '>= "B")~ Note that items without a priority cookie never match this predicate (while Org itself considers items without a cookie to have the default priority, which, by default, is equal to priority ~B~).
|
||||||
+ =property (property &optional value)= :: Return non-nil if current entry has ~PROPERTY~ (a string), and optionally ~VALUE~ (a string). Note that property inheritance is currently /not/ enabled for this predicate. If you need to test with inheritance, you could use a custom predicate form, like ~(org-entry-get (point) "PROPERTY" 'inherit)~.
|
+ =property (property &optional value)= :: Return non-nil if current entry has ~PROPERTY~ (a string), and optionally ~VALUE~ (a string). Note that property inheritance is currently /not/ enabled for this predicate. If you need to test with inheritance, you could use a custom predicate form, like ~(org-entry-get (point) "PROPERTY" 'inherit)~.
|
||||||
+ =regexp (&rest regexps)= :: Return non-nil if current entry matches all of ~REGEXPS~ (regexp strings). Matches against entire entry, from beginning of its heading to the next heading.
|
+ =regexp (&rest regexps)= :: Return non-nil if current entry matches all of ~REGEXPS~ (regexp strings). Matches against entire entry, from beginning of its heading to the next heading.
|
||||||
- Aliases: =r=.
|
- Aliases: =r=.
|
||||||
|
|
|
||||||
52
org-ql.info
52
org-ql.info
|
|
@ -395,13 +395,15 @@ Arguments are listed next to predicate names, where applicable.
|
||||||
Return non-nil if current heading’s buffer’s filename path matches
|
Return non-nil if current heading’s buffer’s filename path matches
|
||||||
any of ‘REGEXPS’ (regexp strings). Without arguments, return
|
any of ‘REGEXPS’ (regexp strings). Without arguments, return
|
||||||
non-nil if buffer is file-backed.
|
non-nil if buffer is file-backed.
|
||||||
‘priority (&optional comparator-or-priority priority)’
|
‘priority (&rest args)’
|
||||||
Return non-nil if current heading has a certain priority.
|
Return non-nil if current heading has a certain priority. ‘ARGS’
|
||||||
‘COMPARATOR-OR-PRIORITY’ should be either a comparator function,
|
may be either a list of one or more priority letters as strings, or
|
||||||
like ‘<=’, or a priority string, like "A" (in which case (‘=’ will
|
a comparator function symbol followed by a priority letter string.
|
||||||
be the comparator). If ‘COMPARATOR-OR-PRIORITY’ is a comparator,
|
For example: ‘(priority "A") (priority "A" "B") (priority '>= "B")’
|
||||||
‘PRIORITY’ should be a priority string. If both arguments are nil,
|
Note that items without a priority cookie never match this
|
||||||
return non-nil if heading has any defined priority.
|
predicate (while Org itself considers items without a cookie to
|
||||||
|
have the default priority, which, by default, is equal to priority
|
||||||
|
‘B’).
|
||||||
‘property (property &optional value)’
|
‘property (property &optional value)’
|
||||||
Return non-nil if current entry has ‘PROPERTY’ (a string), and
|
Return non-nil if current entry has ‘PROPERTY’ (a string), and
|
||||||
optionally ‘VALUE’ (a string). Note that property inheritance is
|
optionally ‘VALUE’ (a string). Note that property inheritance is
|
||||||
|
|
@ -1042,24 +1044,24 @@ Node: org-ql-sparse-tree6635
|
||||||
Node: Queries7435
|
Node: Queries7435
|
||||||
Node: Non-sexp query syntax8296
|
Node: Non-sexp query syntax8296
|
||||||
Node: Predicates9995
|
Node: Predicates9995
|
||||||
Node: Date/time predicates15157
|
Node: Date/time predicates15217
|
||||||
Node: Functions / Macros17792
|
Node: Functions / Macros17852
|
||||||
Node: Agenda-like views18025
|
Node: Agenda-like views18085
|
||||||
Node: Listing / acting-on results19430
|
Node: Listing / acting-on results19490
|
||||||
Node: Changelog24032
|
Node: Changelog24092
|
||||||
Node: 04-pre24569
|
Node: 04-pre24629
|
||||||
Node: 03227742
|
Node: 03227802
|
||||||
Node: 03128123
|
Node: 03128183
|
||||||
Node: 0328318
|
Node: 0328378
|
||||||
Node: 02331291
|
Node: 02331351
|
||||||
Node: 02231517
|
Node: 02231577
|
||||||
Node: 02131783
|
Node: 02131843
|
||||||
Node: 0231980
|
Node: 0232040
|
||||||
Node: 0136013
|
Node: 0136073
|
||||||
Node: Notes36112
|
Node: Notes36172
|
||||||
Node: Comparison with Org Agenda searches36274
|
Node: Comparison with Org Agenda searches36334
|
||||||
Node: org-sidebar37145
|
Node: org-sidebar37205
|
||||||
Node: License37424
|
Node: License37484
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue