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

Macros need more documentation. #730

Closed
quadrupleslap opened this Issue Feb 18, 2017 · 2 comments

Comments

Projects
None yet
3 participants
@quadrupleslap

quadrupleslap commented Feb 18, 2017

Why are they all #[doc(hidden)]? Are we not supposed to use them?

@killercup

This comment has been minimized.

Member

killercup commented Feb 18, 2017

@sgrif

This comment has been minimized.

Member

sgrif commented Feb 18, 2017

Yes, if something is #[doc(hidden)], you aren't supposed to use them, and they're not meant to be public API. Often times we have to make things public from the Rust point of view (either marked as pub or #[macro_export]) because we are using that type/macro inside of a macro which is public API. If something is marked as #[doc(hidden)], that is our way of indicating that you aren't meant to use it. If there's a specific macro that you think should be public API, please let me know.

@sgrif sgrif closed this Feb 18, 2017

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