docs(std): add error docs for path canonicalize #146299
Open
+8
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the missing error documentation for both Path.canonicalize and PathBuf.canonicalize methods. Since both methods are wappers around fs::canonicalize, the error doc is copied directly from that function.
This makes it faster to find what errors might arise when calling
path.canonicalize
orpath_buf.canonicalize
in the editor itself without needing to drill down to thefs::canonicalzie
docs.