Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc of std::fs::canonicalize does not correspond to behavior #54056

Closed
mrclmh opened this issue Sep 8, 2018 · 0 comments
Closed

Doc of std::fs::canonicalize does not correspond to behavior #54056

mrclmh opened this issue Sep 8, 2018 · 0 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools

Comments

@mrclmh
Copy link

mrclmh commented Sep 8, 2018

The doc for canonicalize state that the function will return an error if a component in a path is not a directory.

Using canonicalize on a path with a file component does not return an error for me, e.g.

fs::canonicalize("./src/../Cargo.toml").unwrap();

works without error.

Meta

rustc 1.28.0 (9634041 2018-07-30)
binary: rustc
commit-hash: 9634041
commit-date: 2018-07-30
host: x86_64-apple-darwin
release: 1.28.0
LLVM version: 6.0
@csmoe csmoe added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Sep 8, 2018
tbu- added a commit to tbu-/rust that referenced this issue Dec 15, 2018
@tbu-
Fix doc of std::fs::canonicalize
f61686a 
Point out that the final component of the path name might be a filename
(and not a directory name). Previously, the doc said that all components
of the path must be directory names, when it actually only ment all but
the final one.

Fixes rust-lang#54056.
@tbu- tbu- mentioned this issue Dec 15, 2018
Merged
Centril added a commit to Centril/rust that referenced this issue Dec 16, 2018
@Centril
Rollup merge of rust-lang#56858 - tbu-:pr_doc_canonicalize, r=shepmaster
6574d83 
Fix doc of `std::fs::canonicalize`

Point out that the final component of the path name might be a filename
(and not a directory name). Previously, the doc said that all components
of the path must be directory names, when it actually only ment all but
the final one.

Fixes rust-lang#54056.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mrclmh @csmoe