Skip to content

Combine duplicate occurrences of an exception #1330

Open
@rpetrusha

Description

@rpetrusha

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:

<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="year" /> is not in the range supported by <paramref name="calendar" />.  
 -or-  
<paramref name="month" /> is less than 1 or greater than the number of months in <paramref name="calendar" />.  
-or-  
<paramref name="day" /> is less than 1 or greater than the number of days in <paramref name="month" />.
</exception>

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

<exception cref="T:System.ArgumentOutOfRangeException">
   <paramref name="year" /> is not in the range supported by <paramref name="calendar" />.  
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">  
   <paramref name="month" /> is less than 1 or greater than the number of months in <paramref name="calendar" />.  
</exception>

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Pri3Indicates issues/PRs that are low priorityarea-System.Runtimemigration-fixesIndicates PRs that are related to problems caused by the migration from MSDN

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions