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.

Sign up for GitHub

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

Jump to bottom

Generate documentation for generated metric registries #5

Open
magnet opened this issue Feb 15, 2019 · 0 comments
Open

Generate documentation for generated metric registries #5

magnet opened this issue Feb 15, 2019 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@magnet
Copy link
Owner

magnet commented Feb 15, 2019

It's pretty trivial to add documentation attributes to items generated by a procedural macro, especially in Metered's macros where the registry structures are built using the quote! macro. One would simply annotate the structs and fields with a bunch `#[doc = "The doc comes here"] attributes (the strings have to be constructed dynamically before the quote invocation, to make sure it refers to the right names).
@magnet magnet added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Feb 15, 2019
@magnet magnet changed the title Generate documentation for generated Repositories Generate documentation for generated MetricRegistries Feb 15, 2019
@magnet magnet changed the title Generate documentation for generated MetricRegistries Generate documentation for generated metric registries Feb 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@magnet