From b0b89c5f7e1e775dc4220a9cc3ddb51465d69dcc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Nogueira?= Date: Fri, 22 Nov 2024 12:04:51 -0300 Subject: [PATCH] doc: document +const mapping. --- documentation/qgroup.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/documentation/qgroup.rst b/documentation/qgroup.rst index e8a1eda9..b89c20a3 100644 --- a/documentation/qgroup.rst +++ b/documentation/qgroup.rst @@ -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``: @@ -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