Add search functionality #173
Merged
Conversation
This file contains hidden or 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
I used this to try to get more familiar with the code, but it's of no use now
This fix should give better results and make the code easier to understand as well
Contributor
Author
|
I've made some improvements, like making sure each word has same importance when calculating the score of each page, conforming to the style requirements, and adding a no results found message. I am looking for more feedback on the search feature since I do want to improve it and also get it into the project. |
MasterOdin
reviewed
Nov 20, 2021
Co-authored-by: CleanMachine1 <[email protected]>
MasterOdin
reviewed
Nov 20, 2021
Co-authored-by: Matthew Peveler <[email protected]>
Co-authored-by: Matthew Peveler <[email protected]>
Co-authored-by: Matthew Peveler <[email protected]>
This way, we save a lot of time and prevent the program from being locked up downloading lots of pages and searching through them. However, the final page may still be downloaded in case cache isn't up to date enough. This should be fixed by adding a check to see if cache is up to date or not, but the provided function didn't make a whole bunch of sense to me. Hopefully someone else can provide needed info here.
Contributor
Author
|
This new commit only searches through cache, but may need some more handling of edge cases (like if someone forcibly deletes the cache directory). However such cases seem to be pretty few and far between, so I think it's fine. |
MasterOdin
suggested changes
Dec 19, 2021
Co-authored-by: Matthew Peveler <[email protected]>
MasterOdin
approved these changes
Dec 21, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This is with reference to issue #172, where I proposed adding a search function to search for a specific subcommand for a given program
For example, searching for how to delete a branch in git can be done using this feature, using the command
tldr git --search "delete branch"Keep in mind that the very first word you type is the most impactful when trying to decide the most relevant page, the second one less so and so on and so forth.
While the search algorithm I've devised seems to work fairly well, there are some further enhancements I am looking to implement as well:
Searching for the keywords only in the examples given and not the command/subcommand summary
Highlighting the keywords wherever they are found in the text or only printing the examples where the keywords have been found.
Any code cleanup operations that need to be performed
Improvements to the search algorithm