From 3ac3fa5f1e90361948dc4951eaa643279995bd12 Mon Sep 17 00:00:00 2001 From: Alexander Kuechler Date: Mon, 28 Aug 2023 13:06:15 +0200 Subject: [PATCH] Add more documentation of value evaluation --- docs/docs/GettingStarted/query.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docs/GettingStarted/query.md b/docs/docs/GettingStarted/query.md index 88c735129f..6fb8a49444 100755 --- a/docs/docs/GettingStarted/query.md +++ b/docs/docs/GettingStarted/query.md @@ -112,6 +112,11 @@ set of analyses and functions to use them. These are: - **min(n: Node)**: Minimal value of a node - **max(n: Node)**: Maximal value of a node +- **evaluate(evaluator: ValueEvaluator)**: Evaluates the value of a node. You + can use different evaluators which can affect the possible results. In general, + it makes sense to check if the evaluation succeeded and/or transfer the types. + E.g., the default value evaluator could return different numbers (transferring + them e.g. with `toLong()` or `toFloat()` could make sense), a string, or an error. - **sizeof(n: Node)**: The length of an array or string - **dataFlow(from: Node, to: Node)**: Checks if a data flow is possible between the nodes `from` as a source and `to` as sink.