gnodet-bot commented on code in PR #28389:
URL: https://github.com/apache/camel/pull/28389#discussion_r4366651729


##########
components/camel-openfeature/src/main/docs/openfeature-language.adoc:
##########
@@ -29,8 +29,8 @@ This language is provided by the `camel-openfeature` 
component:
 
 == Usage
 
-The language evaluates the given flag key as a boolean and returns the
-result. It uses the `openfeature:flags` endpoint by default, inheriting
+As a predicate, the language evaluates the given flag key as a boolean.
+As an expression, it gives the string value of the flag, see below. It uses 
the `openfeature:flags` endpoint by default, inheriting

Review Comment:
   📝 **Documentation gap:** This sentence only mentions that the expression 
returns "the string value of the flag", but omits the fallback behaviour. The 
`@BodyTypes` annotation in the same PR explicitly documents that the output is 
*"The string value of the flag, or the `defaultValue` of the endpoint when the 
flag is not a string flag or is missing"*. Users relying solely on this adoc 
description would miss the defaultValue semantics entirely.
   
   Consider expanding to something like:
   
   *As an expression, it gives the string value of the flag (or the endpoint's 
`defaultValue` if the flag is not a string flag or is missing), see below.*



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to