Skip to content
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

strip synstructure consts from compiler docs #60885

Merged
merged 1 commit into from May 29, 2019

Conversation

Projects
None yet
6 participants
@euclio
Copy link
Contributor

commented May 16, 2019

Fixes #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 #60884 to track stabilization of a new flag that encapsulates this behavior.

r? @QuietMisdreavus

@Centril

This comment has been minimized.

Copy link
Member

commented May 16, 2019

The principled fix for this is with #54912.

@euclio

This comment has been minimized.

Copy link
Contributor Author

commented May 16, 2019

@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 #[doc(hidden)].

@Centril

This comment has been minimized.

Copy link
Member

commented May 16, 2019

@euclio That's not my assumption; underscore consts are sort of explicitly for the purpose of "ignore me please I just want a gensym".

@euclio

This comment has been minimized.

Copy link
Contributor Author

commented May 16, 2019

@Centril

This comment has been minimized.

Copy link
Member

commented May 16, 2019

@euclio hmm... interesting; the synstructure consts are public...? but why... 😕

@euclio

This comment has been minimized.

Copy link
Contributor Author

commented May 16, 2019

@Centril They aren't, they just appear due to --document-private-items. Regardless, this discussion seems more appropriate for the tracking issue. I'll move my questions there.

@GuillaumeGomez

This comment has been minimized.

Copy link
Member

commented May 29, 2019

Thanks!

@bors: r+ rollup

@bors

This comment has been minimized.

Copy link
Contributor

commented May 29, 2019

📌 Commit c95be3d has been approved by GuillaumeGomez

@Centril

This comment has been minimized.

Copy link
Member

commented May 29, 2019

@bors rollup-

@GuillaumeGomez Please avoid rolling up lockfile changes :)

Centril added a commit to Centril/rust that referenced this pull request May 29, 2019

Rollup merge of rust-lang#60885 - euclio:strip-synstructure-consts, r…
…=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

This was referenced May 29, 2019

bors added a commit that referenced this pull request May 29, 2019

Auto merge of #61314 - Centril:rollup-5q563os, r=Centril
Rollup of 7 pull requests

Successful merges:

 - #60549 (do not print panic message on doctest failures)
 - #60885 (strip synstructure consts from compiler docs)
 - #61192 (Do not ICE on missing access place description during mutability error reporting)
 - #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)
 - #61313 (Simplify Set1::insert)

Failed merges:

r? @ghost

Centril added a commit to Centril/rust that referenced this pull request May 29, 2019

Rollup merge of rust-lang#60885 - euclio:strip-synstructure-consts, r…
…=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

Auto merge of #61316 - Centril:rollup-yhfxrqo, r=Centril
Rollup of 8 pull requests

Successful merges:

 - #60549 (do not print panic message on doctest failures)
 - #60885 (strip synstructure consts from compiler docs)
 - #61192 (Do not ICE on missing access place description during mutability error reporting)
 - #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

oli-obk added a commit to oli-obk/rust that referenced this pull request May 29, 2019

Rollup merge of rust-lang#60885 - euclio:strip-synstructure-consts, r…
…=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

Auto merge of #61317 - oli-obk:rollup-tm5qivq, r=oli-obk
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

@bors bors merged commit c95be3d into rust-lang:master May 29, 2019

1 check passed

Travis CI - Pull Request Build Passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.