azure-sdk-for-net
azure-sdk-for-net copied to clipboard
Azure
Documentation for protocol methods
In libraries that have convenience overloads, the recommendation is to hide the protocol overloads using EditorBrowsableNever. This means the methods won't be included in docs. We should have a central docs article explaining protocol methods that can be linked to from all other library READMEs or relevant docs. Note that currently not all libraries expose protocol methods, but the plan is that eventually all libraries would expose these.
This is a very good issue, thanks for creating it @JoshLove-msft.
@scottaddie I know you were looking at DPG documentation is this something already planned? @JoshLove-msft is there a way to add this as a check in static analyzers? I would think any recommendation we want should be added\enforced in our static analyzers?
@alexwolfmsft has added this work to his backlog. Once he's ready to start, I'll set up a meeting to discuss more of the details.
Fixed via https://github.com/dotnet/docs/pull/41744 and published at https://learn.microsoft.com/dotnet/azure/sdk/protocol-convenience-methods