Minor guide fixes #2713
Minor guide fixes #2713
Conversation
site/guide/9-configuration.md
Outdated
| @@ -25,7 +25,7 @@ values: | |||
| | `max_blocking`* | `usize` | Limit on threads to start for blocking tasks. | `512` | | |||
| | `ident` | `string`, `false` | If and how to identify via the `Server` header. | `"Rocket"` | | |||
| | `ip_header` | `string`, `false` | IP header to inspect to get [client's real IP]. | `"X-Real-IP"` | | |||
| | `proxy_proto_header` | `string`, `false` | Header identifying [client to proxy protocol]. | `None` | | |||
There was a problem hiding this comment.
The default is actually None, it's just that you can't set that via TOML.
In general, with the config docs, there's a difficulty in expressing the concepts in such a way that they're not too broad (i.e, too conceptual to the point of being inapplicable) but also not too specific (i.e, they don't obfuscate the concepts entirely and narrow applicability to a single instance). Here, the "default" is something we set in Rust (None), but in this part of the config docs, we're referring largely to the config as TOML while still pointing to the Rust parts of the config. Thus this confusion/issue.
I'd really love to redo the config docs entirely, though I'm not sure what the best approach would be.
There was a problem hiding this comment.
I see. I honestly don't think the docs are particularly bad right now (the contrary), I was (apparently) just confused by this specific setting.
There was a problem hiding this comment.
Noticed this was still open so rebased the branch, removed the mistaken and kept the tiny fix that was left :)
No description provided.