search

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
708 stars 1.55k forks source link

"Significant characters" in Path.GetFullPath #10077

Open Smaug123 opened 3 months ago

Smaug123 commented 3 months ago

Path.GetFullPath is documented in part as follows:

If a path contains no significant characters, it is invalid unless it contains one or more "." characters followed by any number of spaces; then it will be parsed as either "." or "..".

As far as I can see, the term "significant character" is not defined anywhere, either in the docs or apparently on any of the Internet (from thirty seconds of Googling); I believe one must read the code before finding any more references to this term.

dotnet-policy-service[bot] commented 3 months ago

Tagging subscribers to this area: @dotnet/area-system-io

Smaug123 commented 3 months ago

More generally, the docs require a bunch of Windows knowledge to read; e.g. I believe "If you pass in a short file name, it is expanded to a long file name." is meaningless except on Windows? Some other docs are explicit about which parts of their text refer to which platforms, and I think that would help a lot here, because it seems to me that many of the Remarks for GetFullPath are Windows-specific.