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

favour odocls that are not dependencies #9956

Merged
merged 2 commits into from
Feb 15, 2024

Conversation

EmileTrotignon
Copy link
Contributor

When calling sherlodoc on with @doc-new, all the .odocl are indexed by sherlodoc. It makes sense to index the dependencies, but the entries from the dependencies should be given less priority as search results.

This PR passes a --favoured flag to sherlodoc, this flag identifies the .odocls that are not external. In turn, sherlodoc ranks these entries higher.

@rgrinberg rgrinberg requested a review from jonludlam February 9, 2024 18:57
@rgrinberg rgrinberg added the odoc Issues and PRs related to documentation generation with odoc label Feb 9, 2024
@jonludlam
Copy link
Member

Looks correct to me. Just needs a rebase.

@rgrinberg
Copy link
Member

Also, please DCO

Signed-off-by: Emile Trotignon <[email protected]>
@rgrinberg rgrinberg modified the milestones: 3.14.0, 3.15.0 Feb 15, 2024
_
Signed-off-by: Rudi Grinberg <[email protected]>
@rgrinberg rgrinberg merged commit b0c5345 into ocaml:main Feb 15, 2024
24 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
odoc Issues and PRs related to documentation generation with odoc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants