Skip to content
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

Macro documentation is sorely lacking #294

Closed
alercah opened this issue Apr 3, 2018 · 3 comments
Closed

Macro documentation is sorely lacking #294

alercah opened this issue Apr 3, 2018 · 3 comments
Labels
A-macros Area: Macros New Content Missing features or aspects of language not currently documented. Tracking Issue

Comments

@alercah
Copy link
Contributor

alercah commented Apr 3, 2018

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

@alercah alercah added Tracking Issue New Content Missing features or aspects of language not currently documented. labels Apr 3, 2018
@Havvy
Copy link
Contributor

Havvy commented Sep 25, 2018

Proc macro documentation is a lot better.

@ehuss ehuss added the A-macros Area: Macros label Mar 11, 2019
@ehuss
Copy link
Contributor

ehuss commented Mar 24, 2019

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.

@ehuss ehuss closed this as completed Mar 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-macros Area: Macros New Content Missing features or aspects of language not currently documented. Tracking Issue
Projects
None yet
Development

No branches or pull requests

4 participants