Skip to content

Prevent some markdown transformation on short docblocks #51861

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

Merged

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Jun 27, 2018

Before:

screen shot 2018-06-28 at 01 46 01

After:

screen shot 2018-06-28 at 01 46 02

This is only performed on short doc blocks, not on plain ones. Not all transformations are prevented (you still have a few like urls, code blocks, etc...).

cc @nical

r? @QuietMisdreavus

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 27, 2018
@TimNN
Copy link
Contributor

TimNN commented Jul 3, 2018

Ping from triage, @QuietMisdreavus / @rust-lang/rustdoc: This PR requires your review.

@QuietMisdreavus
Copy link
Member

@bors r+

@bors
Copy link
Collaborator

bors commented Jul 5, 2018

📌 Commit 6a86ee7 has been approved by QuietMisdreavus

@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 Jul 5, 2018
@bors
Copy link
Collaborator

bors commented Jul 6, 2018

⌛ Testing commit 6a86ee7 with merge a8403e1...

bors added a commit that referenced this pull request Jul 6, 2018
…, r=QuietMisdreavus

Prevent some markdown transformation on short docblocks

Before:

<img width="1440" alt="screen shot 2018-06-28 at 01 46 01" src="https://user-images.githubusercontent.com/3050060/42005762-7d533bbe-7a76-11e8-8361-027886803399.png">

After:

<img width="1440" alt="screen shot 2018-06-28 at 01 46 02" src="https://user-images.githubusercontent.com/3050060/42005768-81bd59a0-7a76-11e8-819b-9b4be72579d6.png">

This is only performed on short doc blocks, not on plain ones. Not all transformations are prevented (you still have a few like urls, code blocks, etc...).

cc @nical

r? @QuietMisdreavus
@bors
Copy link
Collaborator

bors commented Jul 6, 2018

☀️ Test successful - status-appveyor, status-travis
Approved by: QuietMisdreavus
Pushing a8403e1 to master...

@bors bors merged commit 6a86ee7 into rust-lang:master Jul 6, 2018
@GuillaumeGomez GuillaumeGomez deleted the prevent-some-markdown-short-doc branch July 6, 2018 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

5 participants