rename ModelResult > ResultStructure to match README schema description #32
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
fmigneault
reviewed
Aug 20, 2024
Comment on lines
+9
to
12
| class ResultStructure(MLMBaseModel): | ||
| shape: List[Union[int, float]] = Field(..., min_items=1) | ||
| dim_order: List[str] = Field(..., min_items=1) | ||
| data_type: DataType |
There was a problem hiding this comment.
Can you add a ModelResult = ResultStructure alias just after?
This will avoid breaking existing code that could import it directly.
There was a problem hiding this comment.
Also, please add a CHANGELOG entry to indicate the preferred new name.
|
@rbavery If still relevant, rebase against https://github.com/stac-extensions/mlm |
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.
Description
The schema and README refer to a
Result Structurebut the class instac-modelcalls itModelResult. This updates the name instac-modelfor consistency.Related Issue
Type of Change
Checklist
CONTRIBUTING.mdguide;make check;Googleformat for all the methods and classes that I used.