Commit fe8261e0 authored by Bram Schoenmakers's avatar Bram Schoenmakers

Improve help text of the sort subcommand.

parent 810a24b0
......@@ -51,8 +51,13 @@ class SortCommand(Command):
Sorts the file according to the expression. If no expression is given, the
expression in the configuration is used.
The following sort properties are supported:
The expression is a comma separated list of attributes to sort on. The list is
evaluated in order, which means that the first attribute takes higher
precedence, then the second, etc.
The following sort attributes are supported:
* priority - Sort by priority
* creation - Sort by creation date
* completed - Sort by completion state
* importance - Sort by importance
......@@ -60,6 +65,10 @@ The following sort properties are supported:
* text - Sort by text
* <tag> - Sort by values of the given tag
Any property can be prefixed with 'asc:' and 'desc:' to specify the sort order.
The default is ascending sort.
Each item can optionally be prefixed with asc: and desc: to specify ascending
or descending sort respectively. If not specified, ascending sort is assumed.
Example:
desc:importance,due,desc:priority
"""
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment