JuliaComputing / JuliaHub-Feedback

Public repo for filing JuliaHub issues
6 stars 1 forks source link

Documentation search doesn't always find results it should #144

Open cormullion opened 2 years ago

cormullion commented 2 years ago

I was showing someone the JuliaHub search. It's very good in many ways ... but I noticed some minor problems with a package I'm familiar with, which I thought I'd share with you, in case you need some more test cases.

Doc search for "voronoi" doesn't find Luxor.jl

Doc search for "delaunay" doesn't find that same page Luxor.jl

Doc search for "triangle" doesn't find 30 or so mentions in Luxor.jl docs:

 ag -c --markdown "triangle" docs/src/*
docs/src/example/examples.md:10
docs/src/explanation/imagematrix.md:1
docs/src/howto/geometrytools.md:13
docs/src/howto/polygons.md:5
docs/src/tutorial/quickstart.md:3
docs/src/howto/simplegraphics.md:1

(Code search for "triangle" terminates too early to tell whether it would have made it or not.)

Doc search for "polygon" misses over 100 mentions in Luxor.jl docs:

❯ ag -c "polygon" docs/src/
docs/src/tutorial/quickstart.md:2
docs/src/tutorial/basictutorial.md:9
docs/src/explanation/pathspolygons.md:10
docs/src/explanation/contributing.md:2
docs/src/example/moreexamples.md:1
docs/src/index.md:1
docs/src/howto/geometrytools.md:3
docs/src/howto/text.md:3
docs/src/howto/colors-styles.md:3
docs/src/howto/simplegraphics.md:11
docs/src/howto/polygons.md:113

(It finds JuliaGraphics/Graphics.jl, though ...)

Again, code search terminates too early to tell whether it would have made it.

It's not like Luxor.jl docs haven't made it into the system at all - plenty of hits for "ellipse", "bezier", "hypotrochoid", "mesh", etc - but no documentation search hits for "logo", "intersection", "poisson", or even "font"...

I can't tell whether the Code search has the same issues, because I think it rarely gives me a full set of results.

I'm not aware of anything unusual about the Luxor docs, other than their size... :)

timholy commented 1 year ago

xref #81