-
Notifications
You must be signed in to change notification settings - Fork 12.6k
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
Repr is incorrectly documented for structs with hidden field #128364
Comments
If I remember correctly my open PR #116882 from Oct '23 addresses this. It's still blocked on design decisions:
Footnotes
|
Previous discussions of
repr
documentation:#[repr(transparent)]
where the field is non-public #90435#[repr(transparent)]
if it isn't part of the public ABI #115439I believe the intent was that
repr(transparent)
should only appear in rendered documentation if the field's type is a public API that the documentation reader gets to rely on.This is the case for
repro::Public
, and not the case forrepro::Private
.I believe
repro::Hidden
should be treated more likerepro::Private
for the purpose of documenting repr.In the standard library, this currently impacts
core::pin::Pin
. https://doc.rust-lang.org/1.80.0/core/pin/struct.Pin.htmlThe text was updated successfully, but these errors were encountered: