rustdoc: Render private fields in tuple struct as /* private fields */
#115604
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
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Sep 7, 2023
…e-struct, r=notriddle rustdoc: Render private fields in tuple struct as `/* private fields */` Reopening of rust-lang#110552. All that was missing was a test for the different cases so I added it into the second commit. Description from the original PR: > I've gotten some feedback that the current rustdoc rendering of... > > ``` > struct HasPrivateFields(_); > ``` > > ...is confusing, and I agree with that feedback, especially compared to the field struct case: > > ``` > struct HasPrivateFields { /* private fields */ } > ``` > > So this PR makes it so that when all of the fields of a tuple variant are private, just render it with the `/* private fields */` comment. We can't *always* render it like that, for example when there's a mix of private and public fields. cc `@jsha` r? `@notriddle`
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Sep 7, 2023
…e-struct, r=notriddle rustdoc: Render private fields in tuple struct as `/* private fields */` Reopening of rust-lang#110552. All that was missing was a test for the different cases so I added it into the second commit. Description from the original PR: > I've gotten some feedback that the current rustdoc rendering of... > > ``` > struct HasPrivateFields(_); > ``` > > ...is confusing, and I agree with that feedback, especially compared to the field struct case: > > ``` > struct HasPrivateFields { /* private fields */ } > ``` > > So this PR makes it so that when all of the fields of a tuple variant are private, just render it with the `/* private fields */` comment. We can't *always* render it like that, for example when there's a mix of private and public fields. cc ``@jsha`` r? ``@notriddle``
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Sep 7, 2023
…e-struct, r=notriddle rustdoc: Render private fields in tuple struct as `/* private fields */` Reopening of rust-lang#110552. All that was missing was a test for the different cases so I added it into the second commit. Description from the original PR: > I've gotten some feedback that the current rustdoc rendering of... > > ``` > struct HasPrivateFields(_); > ``` > > ...is confusing, and I agree with that feedback, especially compared to the field struct case: > > ``` > struct HasPrivateFields { /* private fields */ } > ``` > > So this PR makes it so that when all of the fields of a tuple variant are private, just render it with the `/* private fields */` comment. We can't *always* render it like that, for example when there's a mix of private and public fields. cc ```@jsha``` r? ```@notriddle```
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Sep 7, 2023
…llaumeGomez Rollup of 8 pull requests Successful merges: - rust-lang#115345 (MCP661: Move wasm32-wasi-preview1-threads target to Tier 2) - rust-lang#115604 (rustdoc: Render private fields in tuple struct as `/* private fields */`) - rust-lang#115624 (Print the path of a return-position impl trait in trait when `return_type_notation` is enabled) - rust-lang#115629 (Don't suggest dereferencing to unsized type) - rust-lang#115633 (Lint node for `PRIVATE_BOUNDS`/`PRIVATE_INTERFACES` is the item which names the private type) - rust-lang#115634 (Use `newtype_index` for `IntVid` and `FloatVid`.) - rust-lang#115638 (`-Cllvm-args` usability improvement) - rust-lang#115649 (diagnostics: add test case for trait bounds diagnostic) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Sep 8, 2023
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#115345 (MCP661: Move wasm32-wasi-preview1-threads target to Tier 2) - rust-lang#115604 (rustdoc: Render private fields in tuple struct as `/* private fields */`) - rust-lang#115624 (Print the path of a return-position impl trait in trait when `return_type_notation` is enabled) - rust-lang#115629 (Don't suggest dereferencing to unsized type) - rust-lang#115634 (Use `newtype_index` for `IntVid` and `FloatVid`.) - rust-lang#115649 (diagnostics: add test case for trait bounds diagnostic) - rust-lang#115655 (rustdoc: remove unused ID `mainThemeStyle`) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Sep 8, 2023
…llaumeGomez Rollup of 8 pull requests Successful merges: - rust-lang#115345 (MCP661: Move wasm32-wasi-preview1-threads target to Tier 2) - rust-lang#115604 (rustdoc: Render private fields in tuple struct as `/* private fields */`) - rust-lang#115624 (Print the path of a return-position impl trait in trait when `return_type_notation` is enabled) - rust-lang#115629 (Don't suggest dereferencing to unsized type) - rust-lang#115633 (Lint node for `PRIVATE_BOUNDS`/`PRIVATE_INTERFACES` is the item which names the private type) - rust-lang#115634 (Use `newtype_index` for `IntVid` and `FloatVid`.) - rust-lang#115638 (`-Cllvm-args` usability improvement) - rust-lang#115649 (diagnostics: add test case for trait bounds diagnostic) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Sep 8, 2023
Rollup merge of rust-lang#115604 - GuillaumeGomez:private-fields-tuple-struct, r=notriddle rustdoc: Render private fields in tuple struct as `/* private fields */` Reopening of rust-lang#110552. All that was missing was a test for the different cases so I added it into the second commit. Description from the original PR: > I've gotten some feedback that the current rustdoc rendering of... > > ``` > struct HasPrivateFields(_); > ``` > > ...is confusing, and I agree with that feedback, especially compared to the field struct case: > > ``` > struct HasPrivateFields { /* private fields */ } > ``` > > So this PR makes it so that when all of the fields of a tuple variant are private, just render it with the `/* private fields */` comment. We can't *always* render it like that, for example when there's a mix of private and public fields. cc ````@jsha```` r? ````@notriddle````
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.
Reopening of #110552. All that was missing was a test for the different cases so I added it into the second commit.
Description from the original PR:
cc @jsha
r? @notriddle