Skip to content

Commit c0d21cf

Browse files
committed
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
2 parents 8b82470 + 8c6ec5d commit c0d21cf

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

src/libstd/io/cursor.rs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ use cmp;
1515
use io::{self, SeekFrom, Error, ErrorKind};
1616
use slice;
1717

18-
/// A `Cursor` wraps another type and provides it with a [`Seek`][seek]
19-
/// implementation.
20-
///
21-
/// [seek]: trait.Seek.html
18+
/// A `Cursor` wraps another type and provides it with a
19+
/// [`Seek`](trait.Seek.html) implementation.
2220
///
2321
/// Cursors are typically used with in-memory buffers to allow them to
2422
/// implement `Read` and/or `Write`, allowing these buffers to be used

0 commit comments

Comments
 (0)