rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fix module links in std::fmt and the Rust book's documentation chapter.

Browse Source 
The links in the rustdoc for several places in fmt were trying to link to
the std::fmt module but actually linking to std, which was confusing.
While trying to figure out why I noticed that the documentation chapter of
the Rust book has examples that show this same bug (although it doesn't seem
widespread in practice).
This commit is contained in:
Ted Mielczarek
2015-09-30 12:33:38 -04:00
parent c459e897bd
commit 73bd0ba91e
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/doc/trpl/documentation.md
View File

@@ -45,7 +45,7 @@ Rust keeps track of these comments, and uses them when generating
documentation. This is important when documenting things like enums: documentation. This is important when documenting things like enums:
```rust ```rust
/// The `Option` type. See [the module level documentation](../) for more. /// The `Option` type. See [the module level documentation](index.html) for more.
enum Option<T> { enum Option<T> {
/// No value /// No value
None, None,
@@ -57,7 +57,7 @@ enum Option<T> {
The above works, but this does not: The above works, but this does not:
```rust,ignore ```rust,ignore
/// The `Option` type. See [the module level documentation](../) for more. /// The `Option` type. See [the module level documentation](index.html) for more.
enum Option<T> { enum Option<T> {
None, /// No value None, /// No value
Some(T), /// Some value `T` Some(T), /// Some value `T`

18
src/libcore/fmt/mod.rs
View File

@@ -298,7 +298,7 @@ impl<'a> Display for Arguments<'a> {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -393,7 +393,7 @@ pub trait Debug {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -435,7 +435,7 @@ pub trait Display {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -482,7 +482,7 @@ pub trait Octal {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -530,7 +530,7 @@ pub trait Binary {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -578,7 +578,7 @@ pub trait LowerHex {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -624,7 +624,7 @@ pub trait UpperHex {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -668,7 +668,7 @@ pub trait Pointer {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///
@@ -711,7 +711,7 @@ pub trait LowerExp {
/// ///
/// For more information on formatters, see [the module-level documentation][module]. /// For more information on formatters, see [the module-level documentation][module].
/// ///
/// [module]: ../index.html /// [module]: index.html
/// ///
/// # Examples /// # Examples
/// ///