feat: change state to userdict#44
Merged
younesStrittmatter merged 4 commits intomainfrom Sep 3, 2023
Merged
Conversation
musslick
requested changes
Sep 1, 2023
Contributor
musslick
left a comment
There was a problem hiding this comment.
This looks great! The only suggestion I have is to add a minimal jupyter notebook under docs/cycle that outlines the new functionality, i.e., how the state can be modified (adding fields, changing delta functions).
hollandjg
requested changes
Sep 4, 2023
Member
hollandjg
left a comment
There was a problem hiding this comment.
I think this needs a bunch of automated tests before it gets merged — it's such a central part of the core, that we really need confidence it's working!
| S = TypeVar("S", bound=DeltaAddable) | ||
|
|
||
|
|
||
| class StateDict(UserDict): |
Member
There was a problem hiding this comment.
I think this class would benefit from a bunch of doctests which demo and check it's full functionality! You could start with the doctests in the StandardState as an example, and then add the new functionality too.
hollandjg
added a commit
that referenced
this pull request
Nov 29, 2023
…onal-approach docs: update docs with functional workflow approach examples
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.
Description
Change state into a user dict
Type of change
feat: A new feature
BREAKING_CHANGE: Not sure if it breaks existing code, but tests/notebooks in the core worked fine
Remarks (Optional)