FrankChen021 commented on code in PR #20198:
URL: https://github.com/apache/druid/pull/20198#discussion_r3955365440


##########
docs/querying/query-context-reference.md:
##########
@@ -51,7 +51,7 @@ Unless otherwise noted, the following parameters apply to all 
query types, and t
 |`brokerService`    | `null`                                 | Broker service 
to which this query should be routed. This parameter is honored only by a 
broker selector strategy of type *manual*. See [Router 
strategies](../design/router.md#router-strategies) for more details.|
 |`useCache`         | `true`                                 | Flag indicating 
whether to leverage the query cache for this query. When set to false, it 
disables reading from the query cache for this query. When set to true, Apache 
Druid uses `druid.broker.cache.useCache` or `druid.historical.cache.useCache` 
to determine whether or not to read from the query cache |
 |`populateCache`    | `true`                                 | Flag indicating 
whether to save the results of the query to the query cache. Primarily used for 
debugging. When set to false, it disables saving the results of this query to 
the query cache. When set to true, Druid uses 
`druid.broker.cache.populateCache` or `druid.historical.cache.populateCache` to 
determine whether or not to save the results of this query to the query cache |
-|`useResultLevelCache`| `true`                      | Flag indicating whether 
to leverage the result level cache for this query. When set to false, it 
disables reading from the query cache for this query. When set to true, Druid 
uses `druid.broker.cache.useResultLevelCache` to determine whether or not to 
read from the result-level query cache |

Review Comment:
   Yes, the marker is intentional. `<!-- GENERATED QUERY CONTEXT PARAMETER: 
useResultLevelCache -->` is an invisible HTML comment used as a stable anchor: 
the compile-time generator finds the marker and replaces the complete table row 
from descriptor metadata, while preserving the surrounding hand-written 
documentation. It is not rendered as user-facing content. The same marker is 
used for generated rows in the scan and SQL context documents.
   
   <!-- mergelens:review -->



##########
docs/querying/scan-query.md:
##########
@@ -197,7 +197,7 @@ Configuration properties:
 
 |property|description|values|default|
 |--------|-----------|------|-------|
-|maxRowsQueuedForOrdering|The maximum number of rows returned when time 
ordering is used.  Overrides the identically named config.|An integer in [1, 
2147483647]|`druid.query.scan.maxRowsQueuedForOrdering`|
+|maxRowsQueuedForOrdering|The maximum number of rows returned when time 
ordering is used. Overrides the identically named config.|An integer in [1, 
2147483647]|`druid.query.scan.maxRowsQueuedForOrdering`| <!-- GENERATED QUERY 
CONTEXT PARAMETER: maxRowsQueuedForOrdering -->

Review Comment:
   Same explanation: the generated marker is intentional and is the generator's 
replacement anchor; it remains invisible in rendered documentation.
   
   <!-- mergelens:review -->



-- 
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]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to