madrob commented on a change in pull request #1436:
URL: https://github.com/apache/lucene-solr/pull/1436#discussion_r474238251
##########
File path: solr/solr-ref-guide/src/common-query-parameters.adoc
##########
@@ -206,7 +206,7 @@ The default value of this parameter is blank, which causes
no extra "explain inf
== timeAllowed Parameter
-This parameter specifies the amount of time, in milliseconds, allowed for a
search to complete. If this time expires before the search is complete, any
partial results will be returned, but values such as `numFound`,
<<faceting.adoc#faceting,facet>> counts, and result
<<the-stats-component.adoc#the-stats-component,stats>> may not be accurate for
the entire result set. In case of expiration, if `omitHeader` isn't set to
`true` the response header contains a special flag called `partialResults`.
+This parameter specifies the amount of time, in milliseconds, allowed for a
search to complete. If this time expires before the search is complete, any
partial results will be returned, but values such as `numFound`,
<<pagination-of-results.adoc#using-cursors,`nextCursorMark`>>,
<<faceting.adoc#faceting,facet>> counts, and result
<<the-stats-component.adoc#the-stats-component,stats>> may not be accurate for
the entire result set. In case of expiration, if `omitHeader` isn't set to
`true` the response header contains a special flag called `partialResults`.
Review comment:
Sure, if it's clearly documented that certain combinations of parameters
lead to unknowable results, then I think it's fine. Maybe visit the
`omitHeader` docs and put a blatant warning there about use in conjunction with
shards.tolerant, timeAllowed, or any other partial result operations. (WAND?)
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
