Add some more documentation to factors #2636
Merged
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
lann
reviewed
Jul 12, 2024
lann
approved these changes
Jul 12, 2024
Signed-off-by: Ryan Levick <ryan.levick@fermyon.com>
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.
First pass just giving a bit more context on the various pieces of the factors system. I think this will mainly help for hovering over types in IDEs to remind users what things are.
Besides documentation one code change is made:
RuntimeFactors::build_store_data=>RuntimeFactors::build_instance_state. I know that the value returned from this method is what gets passed towasmtime::Store::newwhich refers to it asdata, but given the rest of the factors framework refers to this as instance state (which is much more descriptive than wasmtime's nomenclature), I think this is a better name.