about summary refs log tree commit diff
path: root/src/rustllvm/RustWrapper.cpp
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-07-29 10:30:35 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-07-29 10:30:35 -0400
commitc0d21cfe587abe02834714be2530a5857362e120 (patch)
tree3ca54bd91d1ab26d1d833d28782dccd40393f098 /src/rustllvm/RustWrapper.cpp
parent8b82470456475ca5ffe8c996de13c8a2b8b6bbfb (diff)
parent8c6ec5d72c3a337d452a16ce369a8d6d3d6d895b (diff)
downloadrust-c0d21cfe587abe02834714be2530a5857362e120.tar.gz
rust-c0d21cfe587abe02834714be2530a5857362e120.zip
Rollup merge of #27345 - killercup:patch-15, r=alexcrichton
The first paragraph of the docs of the Cursor struct ([src](https://github.com/rust-lang/rust/blob/ff6c6ce917bd6af9c5d9315708ae6be3ba0b7e91/src/libstd/io/cursor.rs#L18-L21)) contains a Markdown link. In listings (like <http://doc.rust-lang.org/nightly/std/io/>), this won't get rendered:

![std__io_-_rust](https://cloud.githubusercontent.com/assets/20063/8925843/5c5281a8-350b-11e5-8c63-09a369d746b0.png)

The hotfix would be to change the link by reference:

```rust
/// A `Cursor` wraps another type and provides it with a [`Seek`][seek]
/// implementation.
///
/// [seek]: trait.Seek.html
```

to a direct link:

```rust
/// A `Cursor` wraps another type and provides it with a
/// [`Seek`](trait.Seek.html) implementation.
```

_I have not tested this as I don't have access to a machine for compiling Rust right now._

(This seems to be a more general issue, but I think I have seen this mentioned before. This PR is just to hotfix on particular occurrence. Rustdoc seems to only read the first paragraph of a doc string for the description in index pages, and _after that_ convert Markdown to HTML.)

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