std: Improve docs for mod 'result'
doc: Address review feedback
auto merge of #13499 : brson/rust/resultdocs, r=brson

This adds some fairly extensive documentation for `Result`.

I'm using manual links to other rustdoc html pages a bit.