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

API documentation debt - System.ServiceModel #43855

Open
Tracked by #43849
carlossanlop opened this issue Oct 26, 2020 · 2 comments
Open
Tracked by #43849

API documentation debt - System.ServiceModel #43855

carlossanlop opened this issue Oct 26, 2020 · 2 comments
Labels
area-System.ServiceModel documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@carlossanlop
Copy link
Member

carlossanlop commented Oct 26, 2020

Area owners: @HongGit @mconnew

The APIs in the list below are missing some or all of their documentation. For this particular namespace, please add the missing documentation directly in dotnet-api-docs. The table below will let you know the location of the xml file where the API lives.

Please make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

System.ServiceModel
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
M:System.ServiceModel.Channels.BindingParameterCollection.GetKeyForItem(System.Object) Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ServiceModel.Channels/BindingParameterCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Channels.BindingParameterCollection.GetKeyForItem?branch=master
M:System.ServiceModel.Channels.BindingParameterCollection.InsertItem(System.Int32,System.Object) Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ServiceModel.Channels/BindingParameterCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Channels.BindingParameterCollection.InsertItem?branch=master
M:System.ServiceModel.Channels.BindingParameterCollection.SetItem(System.Int32,System.Object) Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ServiceModel.Channels/BindingParameterCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Channels.BindingParameterCollection.SetItem?branch=master
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors labels Oct 26, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 26, 2020
@Dotnet-GitSync-Bot Dotnet-GitSync-Bot added area-Meta untriaged New issue has not been triaged by the area owner labels Oct 26, 2020
@mconnew
Copy link
Member

mconnew commented Oct 26, 2020

@carlossanlop, the source code the WCF isn't in this repo, it's in the dotnet/wcf repo. Just want to make sure the process to grab the documentation from the source code will be scanning the wcf repo and not be looking for it in this repo?

@carlossanlop
Copy link
Member Author

@mconnew I didn't know the source code was in a separate repo, so thank you for letting me know.

For this particular case, I will ask you to add documentation directly in dotnet-api-docs, as in previous efforts. I will edit the description.

I will bring up the dotnet/wcf repo in our planning.

@HongGit HongGit modified the milestones: 6.0.0, 7.0.0 Jul 14, 2021
@jeffschwMSFT jeffschwMSFT removed the untriaged New issue has not been triaged by the area owner label Jul 21, 2021
@StephenMolloy StephenMolloy modified the milestones: 7.0.0, Future Aug 18, 2022
@ghost ghost added the untriaged New issue has not been triaged by the area owner label Aug 18, 2022
@HongGit HongGit removed the untriaged New issue has not been triaged by the area owner label Aug 23, 2022
@HongGit HongGit added this to the Future milestone Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.ServiceModel documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Development

No branches or pull requests

6 participants