search

dotnet / platform-compat

Roslyn analyzer that finds usages of APIs that will throw PlatformNotSupportedException on certain platforms.
MIT License
278 stars 45 forks source link

Support for API Guidance #197

Open sdmaclea opened 5 years ago

sdmaclea commented 5 years ago

There are categories of API advice for which deprecation seems like too strong a word.

It seems like this is also an ideal place to notify of less severe issues (guidance).

I am thinking about this for the issues surrounding APIs which are inferring their Assembly load context from their caller and sometimes get this wrong. See https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/AssemblyLoadContext.ContextualReflection.md

For these APIs it seems some guidance especially for Framework and library developers is in order.

I was contemplating creating the guidance exactly as done for deprecated items, but using a different prefix. Something like GD0001. Not sure whether this would work or not. Probably would need some other work (especially around suppression and configuration).

//cc @jkotas @jeffschwMSFT @Vitek-karas