route rank clarification
szabgab opened this issue · comments
What kind of documentation problem are you reporting?
Unclear Docs
Where is the issue found?
https://rocket.rs/v0.5/guide/requests/#forwarding
What's wrong?
https://rocket.rs/v0.5/guide/requests/ in the Forwarding section has this text: "Rocket chooses a default ranking from -12 to -1," while the example following it uses positive numbers for ranks. It is rather confusing. Should the ranks be number between 1-12? Maybe what it mean is that by default it is set between -12 and -1 but the developer can set it to any positive whole number?
ps. I could not find this text in the repo, but I had to check the checkbox of "exists on the master on GitHub"
System Checks
- I confirmed that the issue still exists on
master
on GitHub. - I was unable to find a previous report of this problem.
Should the ranks be number between 1-12?
No, it's correct as written, and hopefully the following section makes it clear that -12
to -1
is indeed correct.
Maybe what it mean is that by default it is set between -12 and -1 but the developer can set it to any positive whole number?
This is mostly correct. You can technically set a negative rank when creating a route manually, but you can only set a positive rank when doing so via the attribute. This is by intention. The goal is to avoid confusing the developer by having Rocket assign ranks that the user can also assign.
In any case, I agree that the wording could be improved. Change incoming.