Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for protocol methods #43627

Open
JoshLove-msft opened this issue Apr 24, 2024 · 3 comments
Open

Documentation for protocol methods #43627

JoshLove-msft opened this issue Apr 24, 2024 · 3 comments
Assignees
Labels
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.

Comments

@JoshLove-msft
Copy link
Member

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.

@JoshLove-msft 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
@JoshLove-msft
Copy link
Member Author

/cc @scottaddie

@pallavit
Copy link
Member

pallavit commented 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?

@scottaddie
Copy link
Member

@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.

@scottaddie scottaddie self-assigned this Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.
Projects
None yet
Development

No branches or pull requests

3 participants