[docs] Mark KnownLayout derive #[doc(hidden)] #588
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jswrenn
previously approved these changes
Nov 2, 2023
joshlf
force-pushed
the
known-layout-derive-doc-hidden
branch
from
ec5b625
to
300607d
Compare
|
Fixed a bug; need a new review. |
jswrenn
approved these changes
Nov 2, 2023
joshlf
added a commit
that referenced
this pull request
Nov 2, 2023
Re-export derive macros separately, naming them explicitly rather than re-exporting them by glob (i.e., `pub use zerocoy_derive::*`). Previously, in #588, we attempted to shadow the glob import in order to mark `KnownLayout` as `#[doc(hidden)]`, but this had no effect (presumably, the fact that it was `#[doc(hidden)]` meant that it didn't shadow the glob import, at least from `rustdoc`'s perspective). In this commit, we just import everything separately by name, which allows the `#[doc(hidden)]` attribute on the `KnownLayout` derive to have the intended effect. Makes progress on #29
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 2, 2023
Re-export derive macros separately, naming them explicitly rather than re-exporting them by glob (i.e., `pub use zerocoy_derive::*`). Previously, in #588, we attempted to shadow the glob import in order to mark `KnownLayout` as `#[doc(hidden)]`, but this had no effect (presumably, the fact that it was `#[doc(hidden)]` meant that it didn't shadow the glob import, at least from `rustdoc`'s perspective). In this commit, we just import everything separately by name, which allows the `#[doc(hidden)]` attribute on the `KnownLayout` derive to have the intended effect. Makes progress on #29
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.