Skip to content

Document Pattern and Exhaustiveness checking #657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mark-i-m opened this issue Apr 1, 2020 · 6 comments
Closed

Document Pattern and Exhaustiveness checking #657

mark-i-m opened this issue Apr 1, 2020 · 6 comments
Labels
A-exhaustiveness-check Area: exhaustiveness checking A-patterns Area: patterns C-enhancement Category: enhancement E-hard Difficulty: might require advanced knowledge E-help-wanted Call for participation: extra help is wanted T-compiler Relevant to compiler team

Comments

@mark-i-m
Copy link
Member

mark-i-m commented Apr 1, 2020

We added a skeleton chapter in #651.

cc @Centril

@Centril
Copy link
Contributor

Centril commented Apr 1, 2020

cc @arielb1 @varkor @Nadrieril

@Centril Centril added E-hard Difficulty: might require advanced knowledge E-help-wanted Call for participation: extra help is wanted labels Apr 1, 2020
@Nadrieril
Copy link
Member

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 ?

@Centril
Copy link
Contributor

Centril commented Apr 8, 2020

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.

@mark-i-m
Copy link
Member Author

mark-i-m commented Apr 9, 2020

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.

@Nadrieril
Copy link
Member

I'm finally getting around to doing this!

@jieyouxu jieyouxu added C-enhancement Category: enhancement T-compiler Relevant to compiler team A-patterns Area: patterns A-exhaustiveness-check Area: exhaustiveness checking labels Nov 3, 2024
@jieyouxu
Copy link
Member

jieyouxu commented Nov 3, 2024

Triage: #923 added high-level docs and points to doc comments in source code, we should prefer opening more specific issues for follow-ups. Closing as resolved.

@jieyouxu jieyouxu closed this as completed Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-exhaustiveness-check Area: exhaustiveness checking A-patterns Area: patterns C-enhancement Category: enhancement E-hard Difficulty: might require advanced knowledge E-help-wanted Call for participation: extra help is wanted T-compiler Relevant to compiler team
Projects
None yet
Development

No branches or pull requests

4 participants