slackhappy commented on a change in pull request #1436:
URL: https://github.com/apache/lucene-solr/pull/1436#discussion_r474794540
##########
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:
I added a notice to `omitHeader`
##########
File path: solr/solr-ref-guide/src/common-query-parameters.adoc
##########
@@ -252,7 +252,7 @@ The default value of this parameter is `false`.
This parameter may be set to either `true` or `false`.
-If set to `true`, this parameter excludes the header from the returned
results. The header contains information about the request, such as the time it
took to complete. The default value for this parameter is `false`.
+If set to `true`, this parameter excludes the header from the returned
results. The header contains information about the request, such as the time it
took to complete. The default value for this parameter is `false`. When using
parameters such as
<<common-query-parameters.adoc#timeallowed-parameter,`timeAllowed`>>, and
<<solrcloud-query-routing-and-read-tolerance.adoc#shards-tolerant-parameter,`shards.tolerant`>>,
which can lead to partial results, it is advisable to keep the keep the
header, so that the `partialResults` flag can be checked, and values such as
`numFound`, `nextCursorMark`, <<faceting.adoc#faceting,Facet>> counts, and
result <<the-stats-component.adoc#the-stats-component,Stats>> can be
interpreted in the context of partial results.
Review comment:
<img width="920" alt="solr-14413-docs-omitHeader"
src="https://user-images.githubusercontent.com/685141/90911861-98c03b80-e3a7-11ea-910a-d1f9d8d266f6.png";>
----------------------------------------------------------------
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
![https://user-images.githubusercontent.com/685141/90911861-98c03b80-e3a7-11ea-910a-d1f9d8d266f6.png"](https://user-images.githubusercontent.com/685141/90911861-98c03b80-e3a7-11ea-910a-d1f9d8d266f6.png"){kind=link}