Here's what I would like to be able to do:
- Visit http://doc.rust-lang.org/std/
- In the search box, type any keyword, such as
match
- Get back comprehensive documentation about
match's functionality, similar to the documentation for the primitive types (ex: pointer)
For unused but reserved keywords, I would expect to see something along the lines of "This keyword has no current functionality but is reserved for Rust to possibly use in the future."
Why this is important
Currently, all the details about pattern matching syntax is only documented in the book, as far as I can tell. In the new version of the book, we're moving away from trying to be comprehensive towards just covering the most important, most commonly used constructs. But if we remove documentation about, say, the precedence of | and match guards, where will people go to learn about it? (The Reference doesn't have anything about that stuff either).
Furthermore, how is a new rustacean supposed to know that, say, i32 and pointer will return results but match and where will not?
I'm going to research how the primitive types are documented, but wanted to file this for discussion purposes in the meantime.
Here's what I would like to be able to do:
matchmatch's functionality, similar to the documentation for the primitive types (ex: pointer)For unused but reserved keywords, I would expect to see something along the lines of "This keyword has no current functionality but is reserved for Rust to possibly use in the future."
Why this is important
Currently, all the details about pattern matching syntax is only documented in the book, as far as I can tell. In the new version of the book, we're moving away from trying to be comprehensive towards just covering the most important, most commonly used constructs. But if we remove documentation about, say, the precedence of
|and match guards, where will people go to learn about it? (The Reference doesn't have anything about that stuff either).Furthermore, how is a new rustacean supposed to know that, say,
i32andpointerwill return results butmatchandwherewill not?I'm going to research how the primitive types are documented, but wanted to file this for discussion purposes in the meantime.