Fix readme not being searched #452
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While writing the documentation for search_packages, I noticed that package readme is not actually being searched currently by rosindex, although there is code that purports to do this. I could find no evidence that this is a recent bug, the code in question is 10 years old.
You can demo this by searching for 'slam' in humble using the official index versus a version with this PR included. Without this PR, 17 packages are found. With it, 33. An example package is mrpt_map_server which mentions SLAM only in the readme, so does not appear without this PR.
A downside of this is that it makes the index.REPO.json files 2-3x larger. That means an increase in size from around 6 to around 16 megabytes for some distros. On my home setup (fiber internet 500/500 speed) the existing file downloads async in 169 milliseconds, that could presumably stretch to 500 ms with this change. This is done async as soon as the user gives focus to the search field, so under normal circumstances this is not noticed. I thought about reintroducing shrouding, but I lean against it. But it is an option (either now or later if this PR is accepted as it).