dotnet/roslyn

Update Quick Info and Method Info to show exception reasons

Open

#1,515 opened on Mar 24, 2015

View on GitHub
 (24 comments) (55 reactions) (0 assignees)C# (4,257 forks)batch import
Area-IDEhelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

Currently the Quick Info and Method Info features for the C# editor show the types of exceptions potentially thrown by the method (according to the documentation), but it does not include the descriptions of the reasons why these exceptions could be thrown.

It would be very helpful if the documentation presentation were updated to include this information, so method callers are more likely to correctly consider preconditions.

Contributor guide

Research direction
Investigate the current implementation of Quick Info and Method Info in the Roslyn editor layer to understand how exception types are displayed, then extend the code to also fetch and display exception reason descriptions from XML documentation.
Tech stack
csharp
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Roslyn Editor APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50