From 5e52d4633ab77279a9eafc4218466096a2cd8fc1 Mon Sep 17 00:00:00 2001 From: Daniel Date: Mon, 1 Feb 2021 10:59:17 +0100 Subject: [PATCH] Added a comment re generic peg.js grammar --- odata/lib/odata2cqn.pegjs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/odata/lib/odata2cqn.pegjs b/odata/lib/odata2cqn.pegjs index 00e23916..62764e1a 100644 --- a/odata/lib/odata2cqn.pegjs +++ b/odata/lib/odata2cqn.pegjs @@ -1,5 +1,15 @@ /** ------------------------------------------ - * Odata Spec http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/abnf/odata-abnf-construction-rules.txt + * This is a peg.js adaptation of the https://github.com/oasis-tcs/odata-abnf/blob/master/abnf/odata-abnf-construction-rules.txt + * which directly constructs CQN out of parsed sources. + * + * NOTE: + * In contrast to the OData ABNF source, which uses very detailedsemantic rules, + * this adaptation uses rather generic syntactic rules only, e.g. not distinguishing + * betwenn Collection Navigation or not knowing individual function names. + * This is to be open to future enhancements of the OData standard, as well as + * to improve error messages. For example a typo in a function name could be + * reported specifically instead of throwing a generic parser error. + * * Future test cases http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/abnf/odata-abnf-testcases.xml * * Limitations: Type, Geo functions are not supported,