rustc-dev-guide icon indicating copy to clipboard operation
rustc-dev-guide copied to clipboard

Document Pattern and Exhaustiveness checking

Open mark-i-m opened this issue 5 years ago • 5 comments

We added a skeleton chapter in #651.

cc @Centril

mark-i-m avatar Apr 01 '20 15:04 mark-i-m

cc @arielb1 @varkor @Nadrieril

Centril avatar Apr 01 '20 17:04 Centril

How detailed does that guide aim to be ? Specifically, should we move there the in-depth explanation of the exhaustiveness algorithm that is currently at the top of _match.rs ? Or is that too detailed ?

Nadrieril avatar Apr 08 '20 21:04 Nadrieril

I think starting with the broad strokes, mentioning that there is an in-depth explanation, as well as linking to the paper would be a good start.

Centril avatar Apr 08 '20 22:04 Centril

Generally, it's a bit of judgement call. The goal is just for the guide to be a reasonable starting point for being able to contribute. Generally, that means discussion of important design decisions, data structures, routines, or algorithms, as you see fit.

Another goal is that it should avoid mentioning details that are likely to change, and link to the rustdocs for the compiler as much as possible so that we can detect changes.

mark-i-m avatar Apr 09 '20 04:04 mark-i-m

I'm finally getting around to doing this!

Nadrieril avatar Oct 16 '20 21:10 Nadrieril