The current API documentation still references and demonstrates usage of Try_ConvertResult, which appears to have been removed or deprecated from the codebase.
In particular, there is an example that:
- Imports
Try_ConvertResult
- Derives
Try_ConvertResult
This has two negative effects:
- Compilation failure for users: Copy‑pasting the example into a project will fail to compile because
Try_ConvertResult no longer exists.
- Conceptual confusion: The example demonstrates an outdated pattern instead of the current recommended approach using
#[FromResidual(Result<_, Self::Residual>)].
Requested changes
- Update the affected API docs example(s) to use the new
#[FromResidual(Result<_, Self::Residual>)] pattern.
- Remove
Try_ConvertResult from:
- The import list in the example
- The derive list in the example
- Verify that all API docs and examples referencing
Try_ConvertResult are updated or removed, ensuring there are no remaining references to the old construct.
- Confirm that the revised example compiles and correctly demonstrates the intended usage.
Action items
- Identify all documentation pages and code examples that mention
Try_ConvertResult.
- Replace these references with the current recommended approach using
#[FromResidual(Result<_, Self::Residual>)].
- Run
cargo doc (or the appropriate documentation build command) and ensure all examples compile and tests pass.
- Add a brief note or migration hint (if appropriate) explaining the change from
Try_ConvertResult to FromResidual for users familiar with the old API.
This will keep the documentation aligned with the current API and prevent users from encountering compilation errors when following the examples.
I created this issue for @MusicalNinjaDad from #174 (comment).
Tips and commands
Getting Help
The current API documentation still references and demonstrates usage of
Try_ConvertResult, which appears to have been removed or deprecated from the codebase.In particular, there is an example that:
Try_ConvertResultTry_ConvertResultThis has two negative effects:
Try_ConvertResultno longer exists.#[FromResidual(Result<_, Self::Residual>)].Requested changes
#[FromResidual(Result<_, Self::Residual>)]pattern.Try_ConvertResultfrom:Try_ConvertResultare updated or removed, ensuring there are no remaining references to the old construct.Action items
Try_ConvertResult.#[FromResidual(Result<_, Self::Residual>)].cargo doc(or the appropriate documentation build command) and ensure all examples compile and tests pass.Try_ConvertResulttoFromResidualfor users familiar with the old API.This will keep the documentation aligned with the current API and prevent users from encountering compilation errors when following the examples.
I created this issue for @MusicalNinjaDad from #174 (comment).
Tips and commands
Getting Help