Fix documentation for write! on std::fmt page
#36937
Conversation
| @@ -261,7 +261,8 @@ | |||
| //! This and `writeln` are two macros which are used to emit the format string | |||
| //! to a specified stream. This is used to prevent intermediate allocations of | |||
| //! format strings and instead directly write the output. Under the hood, this | |||
| //! function is actually invoking the `write` function defined in this module. | |||
| //! function is actually invoking the `write_fmt` function defined on the | |||
| //! `std::io::Write` trait. | |||
There was a problem hiding this comment.
While you're at it. Can you add urls for write_fmt and std::io::Write please?
There was a problem hiding this comment.
Sure! Can you check the urls? I'm not sure I added them correctly
|
|
Fixed, thanks! |
| @@ -261,7 +261,9 @@ | |||
| //! This and `writeln` are two macros which are used to emit the format string | |||
| //! to a specified stream. This is used to prevent intermediate allocations of | |||
| //! format strings and instead directly write the output. Under the hood, this | |||
| //! function is actually invoking the `write` function defined in this module. | |||
| //! function is actually invoking the | |||
| //! [`write_fmt`](../../io/trait.Write.html#method.write_fmt) function defined on the | |||
There was a problem hiding this comment.
It looks like the paths are wrong. I've tried ../io/trait.Write.html and ../../io/trait.Write.html but neither seem to work. @GuillaumeGomez any ideas?
There was a problem hiding this comment.
The better thing to test is to build docs and then check by hand:
make docs
Then open doc/index.html with any web browser, go to the modified url and click on it. Then just compare with "real" url and you'll figure out easily.
There was a problem hiding this comment.
Thanks for the tip! When I try that, the links work correctly on my local computer but they still fail on Travis. Should I just remove them for now?
There was a problem hiding this comment.
Yes, I'll take care of them. Once removed, please squash your commits.
2407070 to
3694a4f
Compare
|
@bors: r=frewsxcv rollup |
|
📌 Commit bbd0040 has been approved by |
Fix documentation for `write!` on `std::fmt` page Fixes rust-lang#36906
Fixes #36906