about summary refs log tree commit diff
path: root/src/rustllvm/RustWrapper.cpp
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2017-01-10 21:16:06 +0000
committerbors <bors@rust-lang.org>2017-01-10 21:16:06 +0000
commitd6b927dd91a7f9d32a537f1b4493dfdb3e628823 (patch)
tree8d0c7b1f8b1b38ffd56ce853faeb687e3d33b1c9 /src/rustllvm/RustWrapper.cpp
parent7bffede97cf58f7159e261eac592f9cf88ce209d (diff)
parent0a1c9ae022b3a907af63772d272aadc5c75a49c0 (diff)
downloadrust-d6b927dd91a7f9d32a537f1b4493dfdb3e628823.tar.gz
rust-d6b927dd91a7f9d32a537f1b4493dfdb3e628823.zip
Auto merge of #38843 - Manishearth:proposed, r=GuillaumeGomez
Improved rustdoc rendering for unstable features

This replaces "unstable" with "this is an experimental API", and uses a `<details>` tag to expand to the reason.

The `<details>` tag renders as a regular div (with the details show) on browsers which don't support it, On browsers which do support it, it shows only the summary line with an expandy-arrow next to it, and on clicking it the details will turn up below it.

This is somewhat a strawman proposal. The main issue is that we need to improve our messaging around unstable APIs. Since they turn up in the docs, we should be clearer that they are experimental (and perhaps add something about nightly-only). I'm making this PR to kickstart discussion on this.

Example rendering: http://manishearth.github.io/rust-internals-docs/std/io/trait.Read.html#method.chars

<img width="375" alt="screen shot 2017-01-04 at 10 15 37 pm" src="https://cloud.githubusercontent.com/assets/1617736/21670712/5a96c7de-d2cb-11e6-86a6-87f70818d634.png">

expands to

<img width="799" alt="screen shot 2017-01-04 at 10 15 43 pm" src="https://cloud.githubusercontent.com/assets/1617736/21670714/5db88bb4-d2cb-11e6-8fcc-5cf11d198b75.png">

cc @steveklabnik @jdub
Diffstat (limited to 'src/rustllvm/RustWrapper.cpp')
0 files changed, 0 insertions, 0 deletions