Skip to content

Add a context menu item to open diagnostic help links#455

Merged
tmeschter merged 1 commit intodotnet:masterfrom
tmeschter:OpenAnalyzerHelpLink
Feb 13, 2015
Merged

Add a context menu item to open diagnostic help links#455
tmeschter merged 1 commit intodotnet:masterfrom
tmeschter:OpenAnalyzerHelpLink

Conversation

@tmeschter
Copy link
Contributor

Fixes #93

There are currently three ways to open the help link for a diagnostic:

  1. Click the link in the Error List when the diagnostic is reported.
  2. Open the rule set editor, enable online help, and select the rule.
  3. Select the diagnostic in Solution Explorer, and copy the link from
    the Properties window.

None of these is particularly discoverable. This change adds another
option, a "View Help" menu item that shows up when you right-click on a
diagnostic in Solution Explorer.

Fixes dotnet#93

There are currently three ways to open the help link for a diagnostic:
  1. Click the link in the Error List when the diagnostic is reported.
  2. Open the rule set editor, enable online help, and select the rule.
  3. Select the diagnostic in Solution Explorer, and copy the link from
     the Properties window.

None of these is particularly discoverable. This change adds another
option, a "View Help" menu item that shows up when you right-click on a
diagnostic in Solution Explorer.
@tmeschter
Copy link
Contributor Author

The related .vsct file is not in the repository yet, so that will go out as a separate code review.

@srivatsn
Copy link
Contributor

👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will this do bing search if helplink doesn't actually exist using error ID? it would be nice if it does.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it does not. We don't even show the menu item unless the diagnostic specifies a help link.

I could do this, however. I would rename the menu item to "View/Find Help..." and show it all the time; if no help link is specified we would fall back to a Bing search.

@heejaechang
Copy link
Contributor

👍

tmeschter added a commit that referenced this pull request Feb 13, 2015
Add a context menu item to open diagnostic help links
@tmeschter tmeschter merged commit 40d9ad9 into dotnet:master Feb 13, 2015
@tmeschter tmeschter deleted the OpenAnalyzerHelpLink branch February 13, 2015 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unless a rule fails, it is difficult (impossible?) to find it's on-line help

4 participants