Fix README API documentation to match actual implementation#30
Merged
Fix README API documentation to match actual implementation#30
Conversation
Co-authored-by: cloorc <13597105+cloorc@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix discrepancies between README.md and actual API
Fix README API documentation to match actual implementation
Nov 7, 2025
cloorc
approved these changes
Nov 7, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md documentation to reflect API changes in the matcher library's dimension configuration and weight management system. The changes replace the old constructor-based weight configuration with a builder pattern approach.
Key Changes:
- Updated all code examples to use
NewDimensionConfig().SetWeight()builder pattern instead of passing weights as constructor parameters - Replaced
DimensionWithWeight()method withDimension()+ManualWeight()for explicit weight control - Changed default weight for unconfigured dimensions from
1.0to0.0
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
massiveio
approved these changes
Nov 7, 2025
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
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.
README.md referenced non-existent API methods (
Product(),Route(),Tool(),DimensionWithWeight(),InitializeDefaultDimensions()) that differ from the actual implementation.Changes
API Method Corrections
Product(),Route(),Tool()withDimension(name, value, matchType)DimensionWithWeight()withManualWeight(weight)NewDimensionConfig()signature from(name, index, required, weight)to(name, index, required)+.SetWeight(matchType, weight)NewDimensionConfigWithWeights()Example (Before → After)
All code examples throughout README updated to match actual API in
api.goandtypes.go.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.