Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Search can't find e.g. __init__ #2114

Open
BioTurboNick opened this issue Apr 25, 2023 · 10 comments
Open

Search can't find e.g. __init__ #2114

BioTurboNick opened this issue Apr 25, 2023 · 10 comments
Labels

Comments

@BioTurboNick
Copy link

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

image

@mortenpi mortenpi added Type: Enhancement Format: HTML Related to the default HTML output labels Apr 25, 2023
@mortenpi
Copy link
Member

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

@BioTurboNick
Copy link
Author

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
Copy link
Member

Is the docstring included in the manual?

@KristofferC
Copy link
Member

KristofferC commented Apr 26, 2023

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

(link gets corrupted)

@BioTurboNick
Copy link
Author

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?

image
image

@mortenpi
Copy link
Member

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
Copy link
Member

JuliaLang/julia#45518

@timholy
Copy link
Contributor

timholy commented Feb 3, 2024

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
Copy link

nsajko commented Jul 25, 2024

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
Copy link
Contributor

timholy commented Jul 25, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

6 participants