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.

Sign up for GitHub

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

Jump to bottom

Rustdoc check option #78984

Merged
merged 3 commits into from
Nov 13, 2020
Merged

Rustdoc check option #78984

merged 3 commits into from
Nov 13, 2020

Conversation

GuillaumeGomez
Copy link
Member

The ultimate goal behind this option would be to have rustdoc --check being run when you use cargo check as a second step.

r? @jyn514

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 12, 2020
@jyn514 jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Nov 12, 2020
jyn514
jyn514 approved these changes Nov 12, 2020
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rust-lang/cargo what do you think about adding this to cargo as cargo check --doc (and including it in cargo check --all-targets)?

@shepmaster would you be interested in adding this to playground, even without compiling the docs?

cc @rust-lang/rustdoc

src/librustdoc/lib.rs Show resolved Hide resolved
@ehuss
Copy link
Contributor

ehuss commented Nov 12, 2020

Sounds like it would be useful to me.

@GuillaumeGomez
Copy link
Member Author

Once this PR is merged, I'll add it to cargo then.

@jyn514
Copy link
Member

jyn514 commented Nov 12, 2020

@GuillaumeGomez this isn't very useful unless cargo and playground can use it - do you mind making it insta-stable? Then we can open an FCP and start using it right away.

@GuillaumeGomez
Copy link
Member Author

@jyn514 We can but I was simply thinking about running it on cargo nightly.

@jyn514
Copy link
Member

jyn514 commented Nov 13, 2020

Hmm, ok. We can stabilize in a follow-up PR then.

@bors r+

@bors
Copy link
Contributor

bors commented Nov 13, 2020

📌 Commit a06fd1f has been approved by jyn514

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 13, 2020
@GuillaumeGomez GuillaumeGomez mentioned this pull request Nov 13, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 13, 2020
@bors
Auto merge of rust-lang#79017 - GuillaumeGomez:rollup-5orhudd, r=Guil…
f2a11a2 
…laumeGomez

Rollup of 6 pull requests

Successful merges:

 - rust-lang#77151 (Add regression test for issue rust-lang#76042)
 - rust-lang#77996 (Doc change: Remove mention of `fnv` in HashMap)
 - rust-lang#78463 (Add type to `ConstKind::Placeholder`)
 - rust-lang#78984 (Rustdoc check option)
 - rust-lang#78985 (add dropck test for const params)
 - rust-lang#78996 (add explicit test for const param promotion)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 804ca1d into rust-lang:master Nov 13, 2020
@rustbot rustbot added this to the 1.50.0 milestone Nov 13, 2020
@GuillaumeGomez GuillaumeGomez deleted the rustdoc-check-option branch November 13, 2020 18:37
@GuillaumeGomez GuillaumeGomez mentioned this pull request Nov 13, 2020
Closed
@jyn514 jyn514 mentioned this pull request Jul 2, 2021
Closed
This was referenced Nov 1, 2021
Open
Closed
@edmorley edmorley mentioned this pull request Jan 11, 2022
Closed
@edmorley
Copy link
Contributor

I've filed #92763 for adding this new rustdoc --check option to:
https://doc.rust-lang.org/rustdoc/command-line-arguments.html

@sharnoff sharnoff mentioned this pull request Oct 4, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jyn514 jyn514 jyn514 approved these changes

Assignees

@jyn514 jyn514

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.50.0
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@GuillaumeGomez @ehuss @jyn514 @bors @edmorley @rust-highfive @rustbot