dotnet / dotnet/dotnet-api-docs

Define conditions under which IOException is thrown

Open
#3,599 0 comments 0 reactions 0 assignees View on GitHub
area-System.IO Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

# Define conditions under which IOException is thrown

## General
The [IOException](https://docs.microsoft.com/en-us/dotnet/api/system.io.ioexception?view=netframework-4.7.1#Remarks) documentation needs to be improved to discuss the conditions under which an IOException are thrown.

## Issues with Existing Topics

The [IOException](https://docs.microsoft.com/en-us/dotnet/api/system.io.ioexception?view=netframework-4.7.1#Remarks) documentation treats IOException as a base class of a number of other exceptions (such as FileLoadException, FileNotFoundException, etc.). However, an IOException rather than a derived class exception is thrown under a number of circumstances. For example, an IOException is thrown when no disk space is available; by convention, we don't document this exception condition, since any operation that touches storage can throw the exception.

See PR dotnet/docs#4171

//cc @mairaw @ahman0


4. Suggest reviewers

- If you know someone who can provide feedback, use '@' to ask them to review.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.