1525135 - Error in parameters description for browser.history.search

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: API, enhancement)

Description

[rovyko]

What did you do?

Under the query parameters, it is noted for endTime that "If it is supplied, this option excludes results whose lastVisitTime is later than this time".

What happened?

As per https://bugzilla.mozilla.org/show_bug.cgi?id=1419197, the search will return items that have ANY visits prior to endTime, not just the lastVisitTime.

What should have happened?

The documentation for endTime should be amended to match the Chrome documentation, as the functionality is intended to match Chrome.

from:

"If it is supplied, this option excludes results whose lastVisitTime is later than this time"

to:

"If it is supplied, this option limits results to those visited before this date".

Is there anything else we should know?

Comment 1

[David Flanagan [:djf]]

See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/history/search

Comment 2

[Florian Scholz (Open Web Docs)]

chris, this looks like a content bug, can you re-file on GitHub?

Comment 3

[Chris Mills [:cmills]]

I've read through this bug, and just decided to fix it instead, asn it's a pretty quick fix.

I updated the docs as suggested for the reporter — thanks for reporting this!

Comment 4

[rovyko]

Thank you for taking care of that Chris!

There's only one small detail that might be worth noting. startTime also mentions the use of lastVisitTime to limit results. I'm not sure if the PlacesUtils query is actually using lastVisitTime, but the result is the same.

Comment 5

[Chris Mills [:cmills]]

(In reply to rovyko from comment #4)

Thank you for taking care of that Chris!

There's only one small detail that might be worth noting. startTime also mentions the use of lastVisitTime to limit results. I'm not sure if the PlacesUtils query is actually using lastVisitTime, but the result is the same.

Our page already mentions startTime using lastVisitTime; are you saying you think it shouldn't do?