Use io::Result in prototype documentation #62122
Labels
C-feature-request
Category: A feature request, i.e: not implemented / a PR.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
For a newcomer, there is no reason to expect the return value of any I/O function (ie:
std::io::Result
) to be any different fromstd::result::Result
as they are both shown to beResult
in the documentation.One easy way to disambiguate this would be to show the prototype to use
io::Result
instead ofResult
. For instance, theopen
function is shown as being:pub fn open<P: AsRef<Path>>(path: P) -> Result<File>
It should be:
pub fn open<P: AsRef<Path>>(path: P) -> io::Result<File>
The text was updated successfully, but these errors were encountered: