Add reducer API production warning #1728
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
…ucers being in development and not safe for production use
…ions and Reducers to inform users not to use them in production applications
…nd reducers being in development and not safe for production use
…rs being in development and not safe for production use
…he current limitations of the reducer API in o1js and mention ongoing work to address the issue
…t reducer API in o1js to provide more specific details and current limitations
…rrent limitations and ongoing work to address them
…tion about the limitations of the reducer API in o1js and ongoing efforts to address them.
…n o1js for production applications
…reducer API limitations in o1js
…ention the usage of `reduce()` method in o1js and its limitations
… the reducer API in o1js to inform developers about potential issues in production applications
mitschabaude
approved these changes
Jul 9, 2024
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:
This PR adds a warning about using the current
o1jsreducer API in production applications. This warning was added to the reducer doc comments as well as the examples using the reducer API. A note was also added mentioning that work is actively in progress to mitigate this limitation.This warning will be removed once all work is done to update the reducer API.