-
Notifications
You must be signed in to change notification settings - Fork 558
Closed
Labels
A-exhaustiveness-checkArea: exhaustiveness checkingArea: exhaustiveness checkingA-patternsArea: patternsArea: patternsC-enhancementCategory: enhancementCategory: enhancementE-hardDifficulty: might require advanced knowledgeDifficulty: might require advanced knowledgeE-help-wantedCall for participation: extra help is wantedCall for participation: extra help is wantedT-compilerRelevant to compiler teamRelevant to compiler team
Metadata
Metadata
Assignees
Labels
A-exhaustiveness-checkArea: exhaustiveness checkingArea: exhaustiveness checkingA-patternsArea: patternsArea: patternsC-enhancementCategory: enhancementCategory: enhancementE-hardDifficulty: might require advanced knowledgeDifficulty: might require advanced knowledgeE-help-wantedCall for participation: extra help is wantedCall for participation: extra help is wantedT-compilerRelevant to compiler teamRelevant to compiler team
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
Centril commentedon Apr 1, 2020
cc @arielb1 @varkor @Nadrieril
Nadrieril commentedon Apr 8, 2020
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 commentedon 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 commentedon 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 commentedon Oct 16, 2020
I'm finally getting around to doing this!
jieyouxu commentedon 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.