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.

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

io/fs: add clearer documentation for "unrooted" paths #42716

Open
mpx opened this issue Nov 19, 2020 · 0 comments
Open

io/fs: add clearer documentation for "unrooted" paths #42716

mpx opened this issue Nov 19, 2020 · 0 comments
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Backlog

Comments

@mpx
Copy link
Contributor

mpx commented Nov 19, 2020 •
edited

io/fs requires "unrooted" paths, but it is currently only documented in passing under io/fs.ValidPath.

This may be surprising to many developers starting to use io/fs. Eg, walking "/" on os.DirFS or embed.FS filesystems will fail. Walking "." is less obvious since this is traditionally associated with the current working directory which doesn't exist for virtual filesystems.

Cc @rsc
@cagedmantis cagedmantis added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Nov 30, 2020
@cagedmantis cagedmantis added this to the Backlog milestone Nov 30, 2020
@mpx mpx mentioned this issue Aug 19, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
3 participants
@cagedmantis @mpx @gopherbot