Skip to content

Commit

Permalink
auto merge of #17774 : lambda/rust/docs-mention-hoedown, r=steveklabnik
Browse files Browse the repository at this point in the history
Rust 0.11.0 switched from sundown to the actively maintained hoedown; update the rustdoc documention to mention this.
  • Loading branch information
bors committed Oct 5, 2014
2 parents 5ca68d4 + fe8f430 commit 0262066
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/doc/rustdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ pub use std::option::Option;
```

Doc comments are markdown, and are currently parsed with the
[sundown][sundown] library. rustdoc does not yet do any fanciness such as
[hoedown][hoedown] library. rustdoc does not yet do any fanciness such as
referencing other items inline, like javadoc's `@see`. One exception to this
is that the first paragraph will be used as the "summary" of an item in the
generated documentation:
Expand Down Expand Up @@ -123,7 +123,7 @@ documentation. There is a search bar at the top, which is powered by some
JavaScript and a statically-generated search index. No special web server is
required for the search.

[sundown]: https://github.com/vmg/sundown/
[hoedown]: https://github.com/hoedown/hoedown

# Testing the Documentation

Expand Down

0 comments on commit 0262066

Please sign in to comment.