F1 on our source generator errors goes nowhere because we don't set a HelpUri

[danmoseley]

I got this

clicked on the SYSLIB1052 code, which is hyperlinked, and got an Oops page:

https://learn.microsoft.com/en-us/visualstudio/ide/not-in-toc/default?f1url=%3FappId%3DDev16IDEF1%26l%3DEN-US%26k%3Dk(keywords_removed)%26rd%3Dtrue&view=vs-2022

Not sure if it's just this code.

[teo-tsirpanis]

BTW clicking many newer compiler error codes also leads to a generic error page like this.

[danmoseley]

@buyaa-n how do we handle ensuring that the SYSLIBxxx codes go someplace?

[danmoseley]

should ours all pass HelpLinkUri or should there be useful default behavior somewhere?

[buyaa-n]

how do we handle ensuring that the SYSLIBxxx codes go someplace?

I don't know how SYSLIBxxx links works, seems it should open https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib1050-1069, tagging @gewarren who created that page

[gewarren]

None of the SYSLIB warning links seem to work, even the ones that have a dedicated page (I tried SYSLIB0011 for BinaryFormatter.Serialize). I think this is how the code analysis rules hook up to learn.microsoft.com: https://github.com/dotnet/roslyn-analyzers/blob/2420507acd5863bfe30a7dd97993c9362527045b/src/Utilities/Compiler/DiagnosticDescriptorHelper.cs#L36. @mavasani might be able to suggest a solution for the SYSLIB warnings?

[mavasani]

should ours all pass HelpLinkUri or should there be useful default behavior somewhere?

You should write a DiagnosticDescriptor creation helper in your repo that builds up the help link based on the diagnostic ID and adds it to the descriptor. We do so in both Roslyn and Roslyn-analyzers repo.

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

Issue Details

---

I got this

clicked on the SYSLIB1052 code, which is hyperlinked, and got an Oops page:

https://learn.microsoft.com/en-us/visualstudio/ide/not-in-toc/default?f1url=%3FappId%3DDev16IDEF1%26l%3DEN-US%26k%3Dk(keywords_removed)%26rd%3Dtrue&view=vs-2022

Not sure if it's just this code.

Author:	danmoseley
Assignees:	-
Labels:	area-Interop-coreclr, area-Infrastructure
Milestone:	-

[AaronRobinsonMSFT]

You should write a DiagnosticDescriptor creation helper in your repo that builds up the help link based on the diagnostic ID and adds it to the descriptor.

Seems like this is a general analyzer issue for the repo and no specific to interop.