Repository navigation
docs: remove six dead Search options from Go library options table - #574
Open
philwinder wants to merge 1 commit into
Open
philwinder wants to merge 1 commit into
philwinder wants to merge 1 commit into
Conversation
WithOffset, WithRepositories, WithMinScore, WithEnrichmentTypes, WithSnippets, and WithDocuments populate searchConfig fields but Search.Query only reads searchCfg.limit and searchCfg.languages, so these options have no effect on results.
Contributor
Go Test CoverageTotal coverage: 33.3% Full coverage report |
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
WithOffset,WithRepositories,WithMinScore,WithEnrichmentTypes,WithSnippets, andWithDocumentsfrom the "Search options" table in the Go library docs.Search.Query(application/service/search.go:253-273), the only function in the repo that accepts...SearchOption, only readssearchCfg.limitandsearchCfg.languages. These six options populatesearchConfigfields that are never read, so they have no effect on search results despite being documented alongside options that do work.WithSemanticWeight,WithLimit, andWithLanguagesare left in the table:WithLimit/WithLanguagesgenuinely work, andWithSemanticWeight's removal (the same class of dead-option bug, found separately) is already covered by unmerged PR docs: remove non-functional WithSemanticWeight option from README #570, so it is left untouched here to avoid an overlapping diff.Test plan
verify.shpasses against the updated READMEgrep -n "searchCfg\."thatQueryonly readslimitandlanguagesgrep -rn "\.\.\.SearchOption"that no other function in the repo accepts these options