You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
JoshLove-msft
added
Client
This issue points to a problem in the data-plane of the library.
Docs
MQ
This issue is part of a "milestone of quality" initiative.
labels
Apr 24, 2024
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?
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.
The text was updated successfully, but these errors were encountered: