/ go Public
x/tools/godoc/vfs: path separator character(s) in FileSystem, Opener interfaces is not specified #27715
The path to resolution is known, but the work has not been done.
This label describes issues relating to any tools in the x/tools repository.
golang.org/x/tools/godoc/vfsdoes not clearly specify what the path separator character is expected or allowed to be:
vfs.Openerinterface is affected too:
We need to document it so this is clear to the users and implementors of the interfaces.
Following logic, I expect that it has to be slash, regardless of host OS conventions, since it's meant to be a virtual filesystem that works across platform boundaries, just like
http.FileSystem. (Of course, implementations may use non-slash separator paths to access underlying physical filesystems.)
NeedsDecisionlabel because I want someone else to confirm my reasoning that this is a documentation bug and that we must specify
/as the only allowed path separator element. /cc @andybons @bradfitz
The text was updated successfully, but these errors were encountered: