search

temporalio / sdk-dotnet

Temporal .NET SDK
MIT License
375 stars 30 forks source link

Doc fixes for cref's so that rider doesn't show red warnings #306

Open jakejscott opened 1 month ago

jakejscott commented 1 month ago

What was changed

In Rider, when you open the solutions there's a bunch of red warning showing up for cref docs so I've updated them.

Why?

This fixes the solution wide analysis that Rider runs

Checklist

  1. Closes

  2. How was this tested:

  3. Any docs updates needed?

cretz commented 1 month ago

Thanks!

So there seems two issues with Rider that the .NET team and docfx don't consider issues: 1) Not requiring type arguments when not needed for overload ambiguity (why is Rider ok w/ not providing parameters in these situations but not ok w/ not providing type arguments), and 2) inability to resolve references to things in the scope they are in.

I think these are both Rider bugs if https://learn.microsoft.com/en-us/dotnet/csharp/misc/cs1574 does not warn like it does with crefs .NET/Roslyn actually can't resolve. Otherwise, these are just going to keep happening because not all contributors use this IDE and this IDE is the only one with these problems.