Remove incorrect "read-only file" exception from File.Read* method documentation #11944
+4
−24
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.
Summary
Fixes the confusing and incorrect
UnauthorizedAccessExceptiondocumentation forFile.ReadAllTextandFile.ReadAllLinesmethods that incorrectly stated these methods throw an exception when "path specified a file that is read-only."Problem
The documentation for
ReadAllTextandReadAllLinesmethods included this exception condition:This is misleading and incorrect because:
FileAccess.ReadFile.WriteAllTextwhere it makes senseAs noted in the .NET source code,
File.ReadAllTextopens files with:FileMode.OpenFileAccess.ReadFileShare.ReadChanges
Removed the incorrect exception text from these four method overloads:
File.ReadAllText(string path)File.ReadAllText(string path, Encoding encoding)File.ReadAllLines(string path)File.ReadAllLines(string path, Encoding encoding)The
UnauthorizedAccessExceptiondocumentation now correctly lists only the valid conditions:pathspecified a directoryVerification
Confirmed that all other
File.Read*methods (ReadAllBytes,ReadAllBytesAsync,ReadAllLinesAsync,ReadAllTextAsync,ReadLines,ReadLinesAsync) already had correct documentation without this error.Fixes #<issue_number>
Original prompt
Fixes #11913
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.