rustdoc: Submit examples to play.rust-lang.org #14700
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These were only used for the markdown tests, and there's no reason they should be distinct from the other tests.
| if (window.playgroundUrl) { | ||
| $('pre.rust').hover(function() { | ||
| var klass = $(this).attr('class').replace('rust ', ''); | ||
| var a = $('<a>').text('⇱').attr('class', 'test-arrow'); |
There was a problem hiding this comment.
FWIW, I think this arrow is pointing the "wrong" way for being in the top-right corner, also it's not immediately obvious: it could have text like "edit" or "edit & run" too.
There was a problem hiding this comment.
That's a good point. For now I managed to find some css to flip the arrow so it's pointing in the right direction (I couldn't find the unicode character for that), but someone with a real eye for design should probably look at this at some point.
This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes rust-lang#14654
|
r=me with nits. |
|
Thanks @huonw! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This grows a new option inside of rustdoc to add the ability to submit examples
to an external website. If the
--markdown-playground-urlcommand line optionor crate doc attribute
html_playground_urlis present, then examples will havea button on hover to submit the code to the playground specified.
This commit enables submission of example code to play.rust-lang.org. The code
submitted is that which is tested by rustdoc, not necessarily the exact code
shown in the example.