fix: correct typo and mismatched godoc comment names#200
Open
Liuck27 wants to merge 2 commits intomodelpack:mainfrom
Open
fix: correct typo and mismatched godoc comment names#200Liuck27 wants to merge 2 commits intomodelpack:mainfrom
Liuck27 wants to merge 2 commits intomodelpack:mainfrom
Conversation
Fix a typo in schema/example_test.go where "incercept" was misspelled (should be "intercept"). Fix godoc comments in specs-go/v1/mediatype.go where three weight config constants (MediaTypeModelWeightConfig, MediaTypeModelWeightConfigGzip, MediaTypeModelWeightConfigZstd) had comments referencing the wrong names (MediaTypeModelConfig, MediaTypeModelConfigGzip, MediaTypeModelConfigZstd). Signed-off-by: Luca Secchieri <luca.secchieri@gmail.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request fixes a typo in schema/example_test.go and updates documentation comments in specs-go/v1/mediatype.go to align with the actual constant names. The feedback suggests further clarifying these comments by removing 'config.json' from the list of examples to avoid potential confusion with other media types.
…constants Remove `config.json` from the example files in MediaTypeModelWeightConfig* comments to avoid confusion with the ModelPack artifact config (application/vnd.cncf.model.config.v1+json) defined in docs/config.md. Also fix the description in MediaTypeModelWeightConfigRaw which incorrectly referred to "model weights" instead of "configuration of the model weights". Signed-off-by: Luca Secchieri <luca.secchieri@gmail.com>
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.
Description
schema/example_test.gospecs-go/v1/mediatype.gowhere three weight config constants (MediaTypeModelWeightConfig,MediaTypeModelWeightConfigGzip,MediaTypeModelWeightConfigZstd) had comments incorrectly referencingMediaTypeModelConfig*instead ofMediaTypeModelWeightConfig*Motivation and Context
The godoc comment names did not match their corresponding constants, which could mislead contributors reading the documentation. The typo is a straightforward spelling error.