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

Tags in documentation comments are not indexed #11

Open
art-w opened this issue Feb 1, 2024 · 0 comments
Open

Tags in documentation comments are not indexed #11

art-w opened this issue Feb 1, 2024 · 0 comments

Comments

@art-w
Copy link
Owner

art-w commented Feb 1, 2024

When searching in documentation comments, some words appear to not be indexed. For example Stdlib.Array.get disappears once we add the words from the second line of its documentation to the query (invalid argument, negative, outside..)

I suspect this line in odoc.search is responsible for ignoring @raise ... sections of the comment : https://github.com/ocaml/odoc/blob/master/src/search/text.ml#L53 (since we index the text rendering and not the html one)

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

1 participant