Skip to content

Add warning for invalid start of code blocks in rustdoc - #48596

Merged
alexcrichton merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:invalid-code-block-start
Mar 22, 2018
Merged

Add warning for invalid start of code blocks in rustdoc#48596
alexcrichton merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:invalid-code-block-start

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented Feb 28, 2018

Copy link
Copy Markdown
Member

Follow up of #48382.

Still two things to consider:

  1. Adding test for rustdoc output (but where? In UI or in rustdoc tests?).
  2. Try to fix the span issue.

r? @QuietMisdreavus

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 28, 2018
@QuietMisdreavus

QuietMisdreavus commented Feb 28, 2018

Copy link
Copy Markdown
Contributor

Code looks good. As to your points:

  1. rustdoc tests are currently just focused on the html output of rustdoc, but this changes the stdout/stderr output of rustdoc, which (for rustc) would get tested in UI tests. However, i'm not aware of a way to tell UI tests to execute rustdoc instead of rustc. Maybe there's a way? @Mark-Simulacrum?
  2. What span issue are you referring to?

@GuillaumeGomez

GuillaumeGomez commented Mar 1, 2018

Copy link
Copy Markdown
MemberAuthor

It's not referring to the "correct" place. I have some ideas to fix it, shouldn't be long.

@emilyalbiniemilyalbini added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 5, 2018
@emilyalbini

emilyalbini commented Mar 12, 2018

Copy link
Copy Markdown
Member

Ping from triage @GuillaumeGomez! Is 11 days still not long enough?

@GuillaumeGomez

GuillaumeGomez commented Mar 12, 2018

Copy link
Copy Markdown
MemberAuthor

Been busy. I'll try to fix the issue when I have time.

@GuillaumeGomez
GuillaumeGomezforce-pushed the invalid-code-block-start branch from ee2ad41 to 7786f70CompareMarch 18, 2018 19:35
@GuillaumeGomez

GuillaumeGomez commented Mar 18, 2018

Copy link
Copy Markdown
MemberAuthor

Updated.

@emilyalbiniemilyalbini added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 18, 2018
@QuietMisdreavus

QuietMisdreavus commented Mar 19, 2018

Copy link
Copy Markdown
Contributor

I forget what the code looked like before. Does this fix the "span issue" to your liking?

@GuillaumeGomez

GuillaumeGomez commented Mar 20, 2018

Copy link
Copy Markdown
MemberAuthor

Yes! :)

@QuietMisdreavus

QuietMisdreavus commented Mar 20, 2018

Copy link
Copy Markdown
Contributor

Works for me!

@bors r+

@bors

bors commented Mar 20, 2018

Copy link
Copy Markdown
Collaborator

📌 Commit 7786f70 has been approved by QuietMisdreavus

@borsbors 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 Mar 20, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Mar 21, 2018
@kennytm
Rollup merge ofrust-lang#48596- GuillaumeGomez:invalid-code-block-s…
82e2f36
…tart, r=QuietMisdreavus
Add warning for invalid start of code blocks in rustdoc
Follow up of rust-lang#48382.
Still two things to consider:
1. Adding test for rustdoc output (but where? In UI or in rustdoc tests?).
2. Try to fix the span issue.
r? @QuietMisdreavus
@kennytmkennytm mentioned this pull request Mar 21, 2018
Closed
kennytm added a commit to kennytm/rust that referenced this pull request Mar 22, 2018
@kennytm
Rollup merge ofrust-lang#48596- GuillaumeGomez:invalid-code-block-s…
a848336
…tart, r=QuietMisdreavus
Add warning for invalid start of code blocks in rustdoc
Follow up of rust-lang#48382.
Still two things to consider:
1. Adding test for rustdoc output (but where? In UI or in rustdoc tests?).
2. Try to fix the span issue.
r? @QuietMisdreavus
@kennytmkennytm mentioned this pull request Mar 22, 2018
Merged
bors added a commit that referenced this pull request Mar 22, 2018
@bors
Auto merge of#49264- kennytm:rollup, r=kennytm
5092c6b
Rollup of 23 pull requests
- Successful merges: #48374, #48596, #48759, #48939, #49029, #49069, #49093, #49109, #49117, #49140, #49158, #49188, #49189, #49209, #49211, #49216, #49225, #49231, #49234, #49242, #49244, #49105, #49038
- Failed merges:
@alexcrichton
alexcrichton merged commit 7786f70 into rust-lang:masterMar 22, 2018
@GuillaumeGomez
GuillaumeGomez deleted the invalid-code-block-start branch March 23, 2018 11:05
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@QuietMisdreavusQuietMisdreavus

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@GuillaumeGomez@QuietMisdreavus@emilyalbini@bors@alexcrichton@rust-highfive