Docs: Guidance on whether to indicate CLS compliance

Created on 18 Oct 2018  Â·  3Comments  Â·  Source: dotnet/docs

Can/should we have guidance on whether to indicate CLS compliance? It comes up from customers/community every so often, but in my view the cases for it tend to be weak because they are based on hypothetical cases, or circular logic.

For example:

  1. What if some obscure language is used?

    • I think it'll probably work just fine anyway, as long as you're not actually doing anything that isn't CLS complient

  2. But I want to mark my own assembly as CLS compliant and I can't because it depends on XYZ, which isn't

    • This goes back to (1) and whether there's any point to it at all these days in modern libraries

I think it would be good to have explicit guidance on this that we can point people to.

cc @KathleenDollard @richlander @terrajobst @DamianEdwards


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Area - .NET Guide P2 Pri2 doc-enhancement dotneprod waiting-on-feedback

Most helpful comment

Agreed. Right now the guidance focuses on higher level topics like cross-platform and packaging. There is an opportunity to have one or more articles on the API design. For example:

  • Discussing CLS
  • Recommending Framework Design Guidelines
  • Highlight recommended extension points for logging, configuration, ASP.NET, Azure, etc
  • Providing testable libraries

All 3 comments

Agreed. Right now the guidance focuses on higher level topics like cross-platform and packaging. There is an opportunity to have one or more articles on the API design. For example:

  • Discussing CLS
  • Recommending Framework Design Guidelines
  • Highlight recommended extension points for logging, configuration, ASP.NET, Azure, etc
  • Providing testable libraries

@JamesNK should this be moved to our backlog?

I don't know what the right answer is. It would require some investigation.

Sure, backlog is fine.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ygoe picture ygoe  Â·  3Comments

skylerberg picture skylerberg  Â·  3Comments

svick picture svick  Â·  3Comments

ike86 picture ike86  Â·  3Comments

LJ9999 picture LJ9999  Â·  3Comments