Skip to content

Add stubs for keywords not documented in https://doc.rust-lang.org/std/#keywords yet #60779

Closed

Description

@petrochenkov

The keyword list that we can observe now leaves a pretty bad impression.
It doesn't say that it's a work in progress, it just provides an incorrect list.

When you see this list on the documentation landing page questions arise:
If some keyword is not in the list, is it actually a keyword?
Is the any reason and intent behind a specific keyword missing?

And the answer (perhaps not expected from a respectable project) is that there's no intent.
I seems like some initial keywords were added as a proof of concept, but then everyone forgot about this doc section.

Having "please document me" stubs may motivate people encountering them to complete the work.

Activity

  1. added
    E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on May 13, 2019
  2. petrochenkov commented on May 13, 2019

    @petrochenkov
    ContributorAuthor

    The documentation source can be found in src/libstd/keyword_docs.rs.
    The keyword list can be found in libsyntax_pos/symbol.rs.

  3. added
    E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
    on May 13, 2019
  4. ollie27 commented on May 13, 2019

    @ollie27
    Contributor

    This is part of #34601.

  5. timvisee commented on May 16, 2019

    @timvisee
    Contributor

    Some effort has been made in #60761

  6. added a commit that references this issue on May 17, 2019
    c2e49bf
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-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions