Minor doc fix: Change misleading sample code in rocket_ws#3003
Open
mcclure wants to merge 1 commit into
Open
Conversation
…e Rocket route macros often put "magic" after the ?, so I assumed copying it was required and wrote nonworking code
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.
Check out
https://api.rocket.rs/master/rocket_ws/
It offers three variants of a single function, at the addresses
#[get("/echo?channel")],#[get("/echo?stream")]and#[get("/echo?compose")]. In this case, the?is only a discriminator; accessing/echowith this sample code directly will give you a 404.However, using
?in this case is potentially confusing, and did confuse me. I wrote a small app copypasting thechannelexample and left in the?channel, assuming it to be "<macro>magic" (as is common in Rocket) and required, and then my app did not work, returning 404s when I queried it, because I'd written the route like#[get("/chat?channel")]and then queried it likehttp://localhost/chat.Expected behavior / change in patch
I think you should change the
?s to/s to prevent confusion, and make it clear the intent is one example with three routes rather than three copies of the same example with one route.Note: It might be an experienced Rocket user would have immediately identified the meaning of the
?channelsyntax, but first-contact docs probably should not assume you are an experienced Rocket user.