Skip to content

Macro documentation is sorely lacking #294

Description

@alercah

Our macro documentation currently has slim documentation on macros by example, and nearly no documentation on procedural macros. Additionally, there is almost no documentation about macro invocation, such as where they are allowed or not allowed. Macros are a language feature like any other, and should be fully documented.

The following RFCs should be fully documented, at least:

RFC 0085
RFC 0378
RFC 0453
RFC 0550
RFC 0873
RFC 1681

Activity

  1. Havvy commented on Sep 25, 2018

    @Havvy
    Contributor

    Proc macro documentation is a lot better.

  2. ehuss commented on Mar 24, 2019

    @ehuss
    Contributor

    Macros-by-example are now significantly improved via #511.

    Macro invocation sites, grammar, and more was added in #458.

    Proc-macros were done in #412.

    I believe the listed RFCs are covered now, so closing this issue. There's likely more that can be added about macros, but new issues should probably be opened for specific shortcomings.

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-macrosArea: MacrosNew ContentMissing features or aspects of language not currently documented.Tracking Issue

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions