From 71d8eab9d750feb434d71db2ffc763655b39bd35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Sat, 1 Apr 2023 11:05:50 +0200 Subject: [PATCH] More of member-record documentation. --- MODULES.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/MODULES.md b/MODULES.md index 3100101..636fb12 100644 --- a/MODULES.md +++ b/MODULES.md @@ -98,6 +98,28 @@ Known types are: The structure is perfectly suited for ```print-source-listing``` function. + (member-sub-ref mr sec key [default]) + +* ```mr``` - a member record structure +* ```sec``` - section symbol +* ```key``` - key symbol +* ```default``` - optional default value + +Retrieves given ```key``` from dictionary stored as section ```sec``` +in given ```mr``` structure. If no ```default``` is provided and the +```key``` does not exist it raises an exception. + + (member-sub-set mr sec key value) + +* ```mr``` - a member record structure +* ```sec``` - section symbol +* ```key``` - key symbol +* ```value``` - value to set + +Sets the value of given ```key``` in dictionary stored as section +```sec``` in given ```mr``` structure to the new ```value``` possibly +overwriting previous one. + ### Member Parser ### Members Directory