Commits

Kirill Simonov committed 8321099

Added decorators reference.

  • Participants
  • Parent commits a2741df

Comments (0)

Files changed (1)

File doc/reference.rst

 +======================+===========================+===========================+======================+
 | `chain . link`       | follow a link             |                           |                      |
 +----------------------+---------------------------+---------------------------+----------------------+
-| `chain . attr`       | attribute value           |                           |                      |
+| `chain . attr`       | extract attribute value   |                           |                      |
++----------------------+---------------------------+---------------------------+----------------------+
+| `chain . *`          | extract all attributes    |                           |                      |
 +----------------------+---------------------------+---------------------------+----------------------+
 | `chain ? p`          | records from *chain*      |                           |                      |
 |                      | satisfying condition *p*  |                           |                      |
 +----------------------+---------------------------+---------------------------+----------------------+
 
 
+Decorators
+----------
+
++----------------------+---------------------------+---------------------------+----------------------+
+| Function             | Description               | Example Input             | Output               |
++======================+===========================+===========================+======================+
+| `as(x,title)`        | set the column title      |                           |                      |
++----------------------+---------------------------+---------------------------+----------------------+
+| `x+`                 | sort by *x* in            |                           |                      |
+|                      | ascending order           |                           |                      |
++----------------------+---------------------------+---------------------------+----------------------+
+| `x-`                 | sort by *x* in            |                           |                      |
+|                      | descending order          |                           |                      |
++----------------------+---------------------------+---------------------------+----------------------+
+
+