Fix argument inconsistency in example documentation#1208
Draft
bahamat wants to merge 1 commit intooxidecomputer:mainfrom
Draft
Fix argument inconsistency in example documentation#1208bahamat wants to merge 1 commit intooxidecomputer:mainfrom
bahamat wants to merge 1 commit intooxidecomputer:mainfrom
Conversation
Collaborator
|
I noticed you added your copyright; this seems like what would qualify as a de minimis change; if you feel otherwise let us know. Thanks! |
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.
The "bare minimum" example has (among other things) this:
Then later the examples for registering APIs (both as a free function and as an API trait) don't wrap the argument in
Arc<>.This leads new users into a trap where these two (three) disconnected examples seem like they should work, but lead to a compile error once they add a handler.
Discussing with @davepacheco, it seems the consensus is that
Arcis not particularly recommended here anymore.This change will help new users walk right into a working example, rather than encountering an error.