Search can't find e.g. __init__

[BioTurboNick]

https://docs.julialang.org/en/v1/search/?q=__init__

[mortenpi]

It's not surprising that this might fail. But how is __init__ actually documented? I presume it's not a docstrings..

[BioTurboNick]

Ah, complicating matters is that __init__ has some new documentation in 1.9. But it does have a docstring, in base/docs/basedocs.jl.

There are a few longer pages it shows up in that I'd expect to see, though, such as here: https://docs.julialang.org/en/v1/manual/modules/

[mortenpi]

Is the docstring included in the manual?

[KristofferC]

On dev it is at least: https://docs.julialang.org/en/v1.10-dev/base/base/#__init__

(link gets corrupted)

[BioTurboNick]

And that aside, __module__ has an entry but isn't found by search either. It can be found by searching for module. So the underscores are maybe tripping up the index?

[mortenpi]

So the underscores are maybe tripping up the index?

Yeah, we are probably stripping those characters somewhere, but then forget to do it in another place or something along those line.

[fredrikekre]

JuliaLang/julia#45518

[timholy]

There's a package example that's much smaller than Julia's own docs, in case that helps debugging: JuliaLang/PrecompileTools.jl#34 (comment). You'll see I created a gist with the contents of the search index, in case it helps debug this.

[nsajko]

On https://docs.julialang.org/en/v1.12-dev/, the search also can't find .=, -> or ::, even though they're now included in the docs.

xref JuliaLang/julia#36290

[timholy]

Note that in JuliaLang/PrecompileTools.jl#34 (comment) I've found that:

• the target string does appear in the search_index.js file
• there are behaviors, such as changing results simply by adding .jl to the end of the string, that make one think it's the search logic that's at fault

This is a pretty big issue. I don't speak javascript, unfortunately.

[fingolfin]

The title issue (searching for __init__) is resolved, also similar ones like searching for __module__.

That searching for symbols like .= or && often doesn't work is also reported in issue #1457.

Perhaps the title of this issue should be adjusted, and/or this issue be consolidated with #1457.

Problematic search strings mentioned in the two issues are:

• .=
• ->
• ::
• &&
• ^

But there are many more, e.g. it might be useful to search for # or + in the main Julia docs...