From 1f9ff2dd88abd1b2b4153161c1a4654ff92fe4c7 Mon Sep 17 00:00:00 2001 From: Mark Thom Date: Thu, 18 Jun 2020 23:47:54 -0600 Subject: [PATCH] clarify meaning of AssertItems and QueryItems in BiMetaTrans source-level documentation --- src/examples/bimetatrans/bimetatrans.pl | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/examples/bimetatrans/bimetatrans.pl b/src/examples/bimetatrans/bimetatrans.pl index 0f71bdca..d652d651 100644 --- a/src/examples/bimetatrans/bimetatrans.pl +++ b/src/examples/bimetatrans/bimetatrans.pl @@ -35,12 +35,18 @@ * inputs are expected to be ground, meaning they should not contain * free variables. * + * A RuleML/XML document is assumed to contain an optional Assert + * element (with zero or more children) and zero or more Query + * elements. The children of the Assert element are the Items of + * AssertItems, while the Items of QueryItems each correspond to a + * single Query element. + * * parse_ruleml/3 is meant to subsume an invertible function in the * sense that the top-level query * * ?- parse_ruleml(AssertItems, QueryItems, XML0), % Prolog->RuleML * parse_ruleml(AssertItems0, QueryItems0, XML), % RuleML->Prolog - * AssertItems0 == AssertItems, % Test for expected round-trip results. + * AssertItems0 == AssertItems, % Test for expected round-trip results. * QueryItems0 == QueryItems, * XML0 == XML. * -- 2.54.0