Skip to content

Commit

Permalink
doc: document +const mapping.
Browse files Browse the repository at this point in the history
  • Loading branch information
ericonr committed Nov 22, 2024
1 parent 3ec9526 commit b0b89c5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions documentation/qgroup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ Mapping ``+type``:
- ``proc`` places no fields. The associated ``+channel`` is processed on PUT.
"proc" mappings will almost always set ``+putorder`` to control the relative
ordering of record processing.
- ``const`` places the value of the ``+const`` mapping, so it doesn't use any
information from the enclosing record, if there is any.


Mapping ``+channel``:
Expand Down Expand Up @@ -152,6 +154,8 @@ Additionally, the values of ``+putorder`` also control the order of fields in th
This control is necessary only in limited cases, such as the ``NTTable`` specification,
where the iteration order of fields must match the order of the ``labels`` array.

``+const`` must be set when using ``+type: "const"``. It accepts literals, e.g. integers, floats, and strings.

.. _understandinggroups:

Understanding Groups
Expand Down

0 comments on commit b0b89c5

Please sign in to comment.