dotnet / dotnet/dotnet-api-docs

Combine duplicate occurrences of an exception

Open
#1,330 1 comment 0 reactions 0 assignees View on GitHub
area-System.Runtime migration-fixes Pri3
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

## Combine duplicate occurrences of an exception

When a member throws an exception of a particular type, that exception type should appear only once in the documentation for that particular member. Each exception condition should appear as a separate item. The documentation for an exception with multiple exception conditions should look something like the following:

```

is not in the range supported by .
-or-
is less than 1 or greater than the number of months in .
-or-
is less than 1 or greater than the number of days in .

```
In some cases, there are multiple \ elements for a single exception type. For example:

```

is not in the range supported by .


is less than 1 or greater than the number of months in .

```
Duplicate exception entries should be identifies and replaced with a single exception entry with multiple exception conditions.

```

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.