Skip to content

Minor doc fix: Change misleading sample code in rocket_ws#3003

Open
mcclure wants to merge 1 commit into
rwf2:masterfrom
mcclure:ws-doc-clarity
Open

Minor doc fix: Change misleading sample code in rocket_ws#3003
mcclure wants to merge 1 commit into
rwf2:masterfrom
mcclure:ws-doc-clarity

Conversation

@mcclure

@mcclure mcclure commented Jul 12, 2026

Copy link
Copy Markdown

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 /echo with 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 the channel example 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 like http://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 ?channel syntax, but first-contact docs probably should not assume you are an experienced Rocket user.

…e Rocket route macros often put "magic" after the ?, so I assumed copying it was required and wrote nonworking code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant