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

Add page title to search results #1468

Merged
merged 2 commits into from
Nov 11, 2020

Conversation

IanButterworth
Copy link
Contributor

@IanButterworth IanButterworth commented Nov 10, 2020

With multiple dispatch, often the context of a method name is lost in the search results. rounding is a good example, where 5 of the top 8 results will land you in the Dates section

Current behavior:
image

This PR:

image

I did wonder about whether the page name should preceded the result, or whether there was a nicer way to format it in its current form

@mortenpi mortenpi added Format: HTML Related to the default HTML output Type: Enhancement labels Nov 10, 2020
@mortenpi mortenpi added this to the 0.26.0 milestone Nov 10, 2020
@mortenpi
Copy link
Member

This LGTM, thanks @ianshmean!

I did wonder about whether the page name should preceded the result, or whether there was a nicer way to format it in its current form

I think the information could be organized in some better way in principle. Maybe even multiple lines per search result in a box or something, with page title in a smaller font either above or below? I don't have any specific ideas though how it should look like though.

This definitely improves the status quo though, so I am happy to merge this as is. But if you want to iterate on this, we can also wait.

@IanButterworth
Copy link
Contributor Author

I think go with this and if I have an idea I'm happy to do another PR 👍

@mortenpi mortenpi merged commit cfa7b68 into JuliaDocs:master Nov 11, 2020
@IanButterworth IanButterworth deleted the ib/more_search_info branch November 11, 2020 02:59
@IanButterworth
Copy link
Contributor Author

Would it be possible to get this into the julia 1.6 docs? Has it been released yet?

@mortenpi
Copy link
Member

mortenpi commented Dec 7, 2020

No, it's still sitting on Documenter#master. In principle, there's nothing stopping us from releasing 0.26 though. What's the 1.6 timeline?

@IanButterworth
Copy link
Contributor Author

I think it will fork in the next day or so, so it's tight if we want it to be straightforward. But I guess it's a logical thing to want to be added to an rc.

If there really isn't anything stopping a release, then it could be simple!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants