Hi, I have encountered this a few times already (without remembering other references):
I just searched for “thread” in the Optimizations.jl documentation, giving two results:
However, after clicking on the first page I find that there is no mention of “thread” on this page:
Is this a known bug or what is happening here? Is this something everyone encounters sometimes?
6 Likes
I keep coming across this problem in random package documentations, does anyone know what is going on?
1 Like
I reported this a while ago as a bug. I can’t remember the issue number, from the top of my head.
Edit: Overly eager search-result reporting · Issue #48748 · JuliaLang/julia
1 Like
That issue was closed as a duplicate of another issue (on the Documenter repo), but that one doesn’t have any mention of this particular issue: a search term showing supposed results that don’t actually contain the term. It only has multiple cases of the opposite, i.e. a search term being present in the page but not showing up in the results. @fgerick it’s worth adding the Optimizations.jl “threads” case (and any other similar instances you can remember in other docs) as a comment on the Documenter issue to make sure those are also tested for.
As seen towards the end of that thread, there is a PR that’s intended to fix issues related to search terms:
but it’s not clear whether it fixes this particular issue. It’s a pretty bizarre issue, the only cause I can think of for it is that there is some fuzzy search that’s being overly liberal, and matching eg. “three” with “thread”. That’s just a conjecture though, it’s worth bringing up on Github and maybe in the Slack
#documentation
channel.
The fuzzy search is exceedingly eager. For instance, my name is apparently all over the manual:
1 Like