Auto merge of #124959 - prorealize:update-result-documentation, r=joboet

Refactor examples and enhance documentation in result.rs

- Replaced `map` with `map_err` in the error handling example for correctness
- Reordered example code to improve readability and logical flow
- Added assertions to examples to demonstrate expected outcomes

Author: bors