docs: fix configuration.md ConfigValue references#137
Merged
Conversation
The Return types section documented a ConfigValue dataclass (with field_path, value, checksum, description fields) that does not exist in the package, causing an ImportError for anyone trying to import it. Replace it with the real third dataclass, ServerVersion (version, commit), and clarify that get_all() returns a plain dict[str, str] mapping field paths to their string values rather than a dataclass. Closes #134
zeevdr
added
size: S
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
ConfigValuedataclass (withfield_path,value,checksum,descriptionfields) that does not exist in the package — importing it raises an ImportError.ServerVersion(version,commit), and clarify thatget_all()returns a plaindict[str, str]mapping field paths to their string values rather than a dataclass.Test plan
ServerVersion's actual fields againstsdk/src/opendecree/types.pyget_all()'s actual return type (dict[str, str]) againstsdk/src/opendecree/client.pyCloses #134