Skip to content

rustdoc: warn on empty doc test#63703

Merged
bors merged 1 commit into
rust-lang:masterfrom
tommilligan:warn-empty-doctest
Sep 1, 2019
Merged

rustdoc: warn on empty doc test#63703
bors merged 1 commit into
rust-lang:masterfrom
tommilligan:warn-empty-doctest

Conversation

@tommilligan

Copy link
Copy Markdown
Contributor

Closes #60319.

A doc test that only contains whitespace should result in a warning.

This PR adds detection of empty doc tests to check-code-block-syntax, as having an invalid doc test is mutually exclusive with an empty doc test.

@mati865

This comment has been minimized.

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 22, 2019
@wirelessringo

Copy link
Copy Markdown

Ping from triage. @ollie27 any updates on this? Thanks.

@ollie27

ollie27 commented Aug 31, 2019

Copy link
Copy Markdown
Contributor

Looks good.

@bors r+

@bors

bors commented Aug 31, 2019

Copy link
Copy Markdown
Collaborator

📌 Commit 0ec2e9f has been approved by ollie27

@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 Aug 31, 2019
@bors

bors commented Aug 31, 2019

Copy link
Copy Markdown
Collaborator

⌛ Testing commit 0ec2e9f with merge 59cc53e...

bors added a commit that referenced this pull request Aug 31, 2019
rustdoc: warn on empty doc test

Closes #60319.

A doc test that only contains whitespace should result in a warning.

This PR adds detection of empty doc tests to `check-code-block-syntax`, as having an invalid doc test is mutually exclusive with an empty doc test.
@bors

bors commented Sep 1, 2019

Copy link
Copy Markdown
Collaborator

☀️ Test successful - checks-azure
Approved by: ollie27
Pushing 59cc53e to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Sep 1, 2019
@bors bors merged commit 0ec2e9f into rust-lang:master Sep 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Empty doc tests should be linted

6 participants