strip synstructure consts from compiler docs #60885
Merged
Conversation
This file contains hidden or 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
rust-highfive
added
the
S-waiting-on-review
Contributor
|
The principled fix for this is with #54912. |
Contributor
Author
|
@Centril Not necessarily, it's still unclear what rustdoc's behavior with underscore constants should be. I would assume that underscore consts would appear in documentation unless they are marked with |
Contributor
|
@euclio That's not my assumption; underscore consts are sort of explicitly for the purpose of "ignore me please I just want a gensym". |
Contributor
Author
|
That seems inconsistent to me. I agree that in the majority of cases,
underscore consts would be private, so they would be ignored by rustdoc.
But what if `--document-private-items` is used or if the const is `pub`?
What if the const has a doc comment?
…On Thu, May 16, 2019, 4:43 PM Mazdak Farrokhzad ***@***.***> wrote:
@euclio <https://github.com/euclio> That's not my assumption; underscore
consts are sort of explicitly for the purpose of "ignore me please I just
want a gensym".
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#60885?email_source=notifications&email_token=AAKPCFS4U6Q6KUF6UZQFCCDPVXBPPA5CNFSM4HNPIVS2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODVTAFIQ#issuecomment-493224610>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKPCFVC2UDKLI3KJF2JOFTPVXBPPANCNFSM4HNPIVSQ>
.
|
Contributor
|
@euclio hmm... interesting; the synstructure consts are public...? but why... 😕 |
Contributor
Author
|
@Centril They aren't, they just appear due to |
Member
|
Thanks! @bors: r+ rollup |
Collaborator
|
📌 Commit c95be3d has been approved by |
bors
added
S-waiting-on-bors
Contributor
|
@bors rollup- @GuillaumeGomez Please avoid rolling up lockfile changes :) |
Centril
added a commit
to Centril/rust
that referenced
this pull request
May 29, 2019
…=GuillaumeGomez strip synstructure consts from compiler docs Fixes rust-lang#60150. Unfortunately this PR depends on the use of the deprecated `--passes` flag in bootstrap to keep the `--strip-hidden` pass while still documenting private items. I've opened rust-lang#60884 to track stabilization of a new flag that encapsulates this behavior. r? @QuietMisdreavus
Centril
added a commit
to Centril/rust
that referenced
this pull request
May 29, 2019
…=GuillaumeGomez strip synstructure consts from compiler docs Fixes rust-lang#60150. Unfortunately this PR depends on the use of the deprecated `--passes` flag in bootstrap to keep the `--strip-hidden` pass while still documenting private items. I've opened rust-lang#60884 to track stabilization of a new flag that encapsulates this behavior. r? @QuietMisdreavus
oli-obk
added a commit
to oli-obk/rust
that referenced
this pull request
May 29, 2019
…=GuillaumeGomez strip synstructure consts from compiler docs Fixes rust-lang#60150. Unfortunately this PR depends on the use of the deprecated `--passes` flag in bootstrap to keep the `--strip-hidden` pass while still documenting private items. I've opened rust-lang#60884 to track stabilization of a new flag that encapsulates this behavior. r? @QuietMisdreavus
bors
added a commit
that referenced
this pull request
May 29, 2019
Rollup of 7 pull requests Successful merges: - #60549 (do not print panic message on doctest failures) - #60885 (strip synstructure consts from compiler docs) - #61217 (Account for short-hand init structs when suggesting conversion) - #61261 (is_union returns ty to avoid computing it twice) - #61293 (Print const generics properly in rustdoc) - #61310 (split libcore::mem into multiple files) - #61313 (Simplify Set1::insert) Failed merges: r? @ghost
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Fixes #60150.
Unfortunately this PR depends on the use of the deprecated
--passesflag in bootstrap to keep the--strip-hiddenpass while still documenting private items. I've opened #60884 to track stabilization of a new flag that encapsulates this behavior.r? @QuietMisdreavus