Documentation for flush() function of Write trait is incorrect

[qdot]

The flush() function to the write trait is documented (at https://doc.rust-lang.org/std/io/trait.Write.html) as

fn flush(&mut self) -> Result<()>

However this results in the following error in code:

error: wrong number of type arguments: expected 2, found 1 [E0243]

The return value is expected to be Result<(), std::io::Error>.

[jonas-schievink]

That's a std::io::Result<()>, not std::result::Result<(), ?>

[retep998]

If you click on the Result it will take you to the page for std::io::Result where you will see that it is defined as type Result<T> = Result<T, Error>;. Therefore not a bug, although it is confusing.

[frewsxcv]

If we changed the function signature in the source from:

fn write(&mut self, buf: &[u8]) -> Result<usize>;

to:

fn write(&mut self, buf: &[u8]) -> io::Result<usize>;

would it display the io:: prefix in the documentation? In my opinion, I think it would make sense to do this if so.

[frewsxcv]

fn write(&mut self, buf: &[u8]) -> io::Result<usize>;

I'm actually not sure if this is even possible since this line comes straight from libstd/io/mod.rs.

[sfackler]

rustdoc does not pay attention to the way items are declared in that way.

[steveklabnik]

Triage: no changes here. Not entirely sure this should be fixed, but it's up to the rustdoc team.

[GuillaumeGomez]

#42066 is more global so let's close this one.