Always hide private fields in aliased type #124939
Merged
+84
−0
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
rustbot
added
S-waiting-on-review
|
Based on discussion in #123860 the preferred implementation would seem to be to only hide these if the fields are from an "upstream" dependency and still reveal them if they're in the workspace. |
|
That would indeed be better, but neither |
|
Ah, then it makes sense to defer the preferred implementation until later. |
Urgau
force-pushed
the
hide-private-fields-aliased-type
branch
from
9b25ab4
to
e89a2cc
Compare
|
Created issue #125009 to track the FIXME and added the it in the code. |
GuillaumeGomez
approved these changes
May 11, 2024
|
Thanks! @bors r+ rollup |
bors
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
May 11, 2024
…type, r=GuillaumeGomez Always hide private fields in aliased type This PR adds a new rustdoc pass that unconditionally always strips all private fields in aliased type, since showing them, even with `--document-private-items`, is confusing, unhelpful, and run backwards to the "Aliased type" feature, which is to show the type as it would be seen by the user. r? `@GuillaumeGomez` Fixes rust-lang#124938 Fixes rust-lang#123860
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
May 11, 2024
…type, r=GuillaumeGomez Always hide private fields in aliased type This PR adds a new rustdoc pass that unconditionally always strips all private fields in aliased type, since showing them, even with `--document-private-items`, is confusing, unhelpful, and run backwards to the "Aliased type" feature, which is to show the type as it would be seen by the user. r? ``@GuillaumeGomez`` Fixes rust-lang#124938 Fixes rust-lang#123860
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 11, 2024
…llaumeGomez Rollup of 6 pull requests Successful merges: - rust-lang#124807 (Migrate `run-make/rustdoc-io-error` to `rmake.rs`) - rust-lang#124829 (Enable profiler for armv7-unknown-linux-gnueabihf.) - rust-lang#124939 (Always hide private fields in aliased type) - rust-lang#124963 (Migrate `run-make/rustdoc-shared-flags` to rmake) - rust-lang#124981 (Relax allocator requirements on some Rc/Arc APIs.) - rust-lang#125008 (Add test for rust-lang#122775) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 11, 2024
…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#124096 (Clean up users of rust_dbg_call) - rust-lang#124829 (Enable profiler for armv7-unknown-linux-gnueabihf.) - rust-lang#124939 (Always hide private fields in aliased type) - rust-lang#124963 (Migrate `run-make/rustdoc-shared-flags` to rmake) - rust-lang#124981 (Relax allocator requirements on some Rc/Arc APIs.) - rust-lang#125008 (Add test for rust-lang#122775) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 12, 2024
Rollup merge of rust-lang#124939 - Urgau:hide-private-fields-aliased-type, r=GuillaumeGomez Always hide private fields in aliased type This PR adds a new rustdoc pass that unconditionally always strips all private fields in aliased type, since showing them, even with `--document-private-items`, is confusing, unhelpful, and run backwards to the "Aliased type" feature, which is to show the type as it would be seen by the user. r? ```@GuillaumeGomez``` Fixes rust-lang#124938 Fixes rust-lang#123860
| // the field and not the one given by the user for the currrent crate. | ||
| // | ||
| // FIXME(#125009): Not-local should probably consider same Cargo workspace | ||
| if !i.def_id().map_or(true, |did| did.is_local()) { |
There was a problem hiding this comment.
This caused all cross-crate type-aliased enums to stop rendering:
Because visibility() here returns None.
I'll put up a PR to fix it.
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.
This PR adds a new rustdoc pass that unconditionally always strips all private fields in aliased type, since showing them, even with
--document-private-items, is confusing, unhelpful, and run backwards to the "Aliased type" feature, which is to show the type as it would be seen by the user.r? @GuillaumeGomez
Fixes #124938
Fixes #123860