doc(middlewares) Add more examples and more doctests #2402
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
The idea of this patch is to improve the documentation of the `wasmer-middlewares` crate by doing the following: * Link to the fully detailed existing `metering` example, * Give an overview of how to push a middleware on a compiler, * Give one example per type and function: `Metering`, `MeteringPoints`, `get_remaining_points` and `set_remaining_points`.
Hywan
added
🎉 enhancement
syrusakbary
approved these changes
Jun 7, 2021
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 idea of this patch is to improve the documentation of the
wasmer-middlewarescrate by doing the following:meteringexample,Metering,MeteringPoints,get_remaining_pointsandset_remaining_points.Review