Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upEstablish conventions for macro internals #22607
Labels
Comments
This comment has been minimized.
This comment has been minimized.
I also think double underscore + doc hidden is the way to go. This may even call for triple underscore. It's the only way to be sure. |
This comment has been minimized.
This comment has been minimized.
Actually, a random number of underscores chosen at compile time would probably be more foolproof. |
This comment has been minimized.
This comment has been minimized.
+1, since other libraries can use the same conventions. |
This comment has been minimized.
This comment has been minimized.
(wrong spot, @alexcrichton said should be RFC, closing) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We should establish conventions for how to expose the implementation details of macros as parts of the public API of a crate. Currently we have two "schemes"
__
example#[doc(hidden)]
exampleIt would be nice to standardize on the convention here as most of these internals "we'd really rather not expose". I personally like the double-underscore-prefix-plus-
#[doc(hidden)]
strategy but others may feel differently!Nominating, this may tidy up some of our apis in std.