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

Suggestion: special search for Lean code names? #181

Open
mars0i opened this issue Oct 4, 2024 · 2 comments
Open

Suggestion: special search for Lean code names? #181

mars0i opened this issue Oct 4, 2024 · 2 comments

Comments

@mars0i
Copy link

mars0i commented Oct 4, 2024

Not sure whether this is a Verso issue per se. Maybe it has to be dealt with separately in individual Verso documents?

The suggestion is to provide a special syntax in the search function (or a separate search box?) that allows searching for names for Lean terms.

Example: I was trying to search for by in FPIL. For some reason this doesn't work at all in the search box--maybe it's being excluded as a common word? However, I can search for "by" in a specific page using my browser search. That's tedious, though, because mostly brings up uses of "by" in English. If the FPIL search found instances of "by", it would be even more tedious.

Since code must be marked as code in the document source, it should in theory be possible to do a search that finds a string only when it appears in a code block or inline code. (Sounds easy enough, but that doesn't mean it is.)

I know that if this seems like it's worth implementing, it might not be a priority, but I thought I'd mention it as a possibility.

@david-christiansen
Copy link
Collaborator

Thanks for the great suggestion!

This is absolutely on the radar, and I plan to add it after the first release of the new reference manual. The document has lots of metadata (index entries, definition sites of technical terms, code samples, docstrings, etc) and I'd like all of them to have special support in the search.

@mars0i
Copy link
Author

mars0i commented Oct 4, 2024

Great. I'm not surprised to hear that this was already planned. Thank you!

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

No branches or pull requests

2 participants