Skip to content

Document Pattern and Exhaustiveness checking #657

@mark-i-m

Description

@mark-i-m
Contributor

We added a skeleton chapter in #651.

cc @Centril

Activity

Centril

Centril commented on Apr 1, 2020

@Centril
Contributor
added
E-hardDifficulty: might require advanced knowledge
E-help-wantedCall for participation: extra help is wanted
on Apr 1, 2020
Nadrieril

Nadrieril commented on Apr 8, 2020

@Nadrieril
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

Centril commented on Apr 8, 2020

@Centril
Contributor

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

mark-i-m commented on Apr 9, 2020

@mark-i-m
ContributorAuthor

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

Nadrieril commented on Oct 16, 2020

@Nadrieril
Member

I'm finally getting around to doing this!

jieyouxu

jieyouxu commented on Nov 3, 2024

@jieyouxu
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-exhaustiveness-checkArea: exhaustiveness checkingA-patternsArea: patternsC-enhancementCategory: enhancementE-hardDifficulty: might require advanced knowledgeE-help-wantedCall for participation: extra help is wantedT-compilerRelevant to compiler team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @Centril@Nadrieril@mark-i-m@jieyouxu

        Issue actions

          Document Pattern and Exhaustiveness checking · Issue #657 · rust-lang/rustc-dev-guide