Re: [jira] [Updated] (LUCENE-9267) The documentation of getQueryBuildTime function reports a wrong time unit.

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

Re: [jira] [Updated] (LUCENE-9267) The documentation of getQueryBuildTime function reports a wrong time unit.

Erick Erickson
WDYT about returning milliseconds? It seems silly/confusing to have one method return milliseconds and another nanoseconds. I suppose the calling code would have to be examined to see what the dependencies are....

Best,
Erick

> On Mar 7, 2020, at 09:57, Pierre-Luc Perron (Jira) <[hidden email]> wrote:
>
> 
>     [ https://issues.apache.org/jira/browse/LUCENE-9267?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
>
> Pierre-Luc Perron updated LUCENE-9267:
> --------------------------------------
>    Description:
> As per documentation, the [MatchingQueries|https://lucene.apache.org/core/8_4_1/monitor/org/apache/lucene/monitor/MatchingQueries.html] class returns both getQueryBuildTime and getSearchTime in milliseconds. The code shows [searchTime|https://github.com/apache/lucene-solr/blob/320578274be74a18ce150b604d28a740545fde48/lucene/monitor/src/java/org/apache/lucene/monitor/CandidateMatcher.java#L112] returning milliseconds. However, the code shows [buildTime|https://github.com/apache/lucene-solr/blob/320578274be74a18ce150b604d28a740545fde48/lucene/monitor/src/java/org/apache/lucene/monitor/QueryIndex.java#L280] returning nanoseconds.
>
> The patch changes the documentation of getQueryBuildTime to report nanoseconds instead of milliseconds.
>
>  was:
> As per documentation, the [MatchingQueries|https://lucene.apache.org/core/8_4_1/monitor/org/apache/lucene/monitor/MatchingQueries.html] class returns both getQueryBuildTime and getSearchTime in milliseconds. The code shows [searchTime|https://github.com/apache/lucene-solr/blob/320578274be74a18ce150b604d28a740545fde48/lucene/monitor/src/java/org/apache/lucene/monitor/CandidateMatcher.java#L112] returning milliseconds. However, the code shows [buildTime|https://github.com/apache/lucene-solr/blob/320578274be74a18ce150b604d28a740545fde48/lucene/monitor/src/java/org/apache/lucene/monitor/QueryIndex.java#L280] returning nanoseconds.
>
> The patch changes the documentation of getQueryBuildTime to report nanoseconds instead of milliseconds.
>
> Edit: add reference to github [pull request|https://github.com/apache/lucene-solr/pull/1330]
>
>
>> The documentation of getQueryBuildTime function reports a wrong time unit.
>> --------------------------------------------------------------------------
>>
>>                Key: LUCENE-9267
>>                URL: https://issues.apache.org/jira/browse/LUCENE-9267
>>            Project: Lucene - Core
>>         Issue Type: Task
>>         Components: modules/other
>>   Affects Versions: 8.2, 8.3, 8.4
>>           Reporter: Pierre-Luc Perron
>>           Priority: Trivial
>>             Labels: documentation, newbie, pull-request-available
>>        Attachments: LUCENE-9267.patch
>>
>>         Time Spent: 10m
>> Remaining Estimate: 0h
>>
>> As per documentation, the [MatchingQueries|https://lucene.apache.org/core/8_4_1/monitor/org/apache/lucene/monitor/MatchingQueries.html] class returns both getQueryBuildTime and getSearchTime in milliseconds. The code shows [searchTime|https://github.com/apache/lucene-solr/blob/320578274be74a18ce150b604d28a740545fde48/lucene/monitor/src/java/org/apache/lucene/monitor/CandidateMatcher.java#L112] returning milliseconds. However, the code shows [buildTime|https://github.com/apache/lucene-solr/blob/320578274be74a18ce150b604d28a740545fde48/lucene/monitor/src/java/org/apache/lucene/monitor/QueryIndex.java#L280] returning nanoseconds.
>> The patch changes the documentation of getQueryBuildTime to report nanoseconds instead of milliseconds.
>
>
>
> --
> This message was sent by Atlassian Jira
> (v8.3.4#803005)
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [hidden email]
> For additional commands, e-mail: [hidden email]
>

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