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.

Sign up for GitHub

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

Jump to bottom

Microsoft.Bcl.AsyncInterfaces is missing API documentation #87722

Closed
ViktorHofer opened this issue Jun 17, 2023 · 5 comments · Fixed by #88432
Closed

Microsoft.Bcl.AsyncInterfaces is missing API documentation #87722

ViktorHofer opened this issue Jun 17, 2023 · 5 comments · Fixed by #88432
Assignees
@ericstj
Labels
area-System.Runtime.CompilerServices documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone
8.0.0

Comments

@ViktorHofer
Copy link
Member

See #84917 for more context.

The compiler generated XML file for Microsoft.Bcl.AsyncInterfaces is shipping to customers via the nuget package and is missing public API documentation. The above linked PR disables the compiler error CS1591 until all the API is documented.

When working on this, remove the NoWarn=1591 setting from the project file.
@ViktorHofer ViktorHofer added the documentation Documentation bug or enhancement, does not impact product or test code label Jun 17, 2023
@ghost ghost added the untriaged New issue has not been triaged by the area owner label Jun 17, 2023
@dotnet-issue-labeler dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Jun 17, 2023
@ViktorHofer ViktorHofer mentioned this issue Jun 17, 2023
Merged
@danmoseley danmoseley added area-Infrastructure-libraries and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Jun 18, 2023
@ghost
Copy link

ghost commented Jun 18, 2023

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

Issue Details

See #84917 for more context.

The compiler generated XML file for Microsoft.Bcl.AsyncInterfaces is shipping to customers via the nuget package and is missing public API documentation. The above linked PR disables the compiler error CS1591 until all the API is documented.

When working on this, remove the NoWarn=1591 setting from the project file.

Author: ViktorHofer
Assignees: -
Labels:

documentation, area-Infrastructure-libraries, untriaged
Milestone: -

@ViktorHofer
Copy link
Member Author

@danmoseley do you know owns Microsoft.Bcl.AsyncInterfaces or which label we use for it? This shouldn't be flagged as infrastructure.

@ViktorHofer ViktorHofer added this to the Future milestone Jun 28, 2023
@ViktorHofer ViktorHofer removed the untriaged New issue has not been triaged by the area owner label Jun 28, 2023
@ViktorHofer ViktorHofer modified the milestones: Future, 8.0.0 Jun 28, 2023
@ViktorHofer ViktorHofer added the help wanted [up-for-grabs] Good issue for external contributors label Jun 28, 2023
@ViktorHofer
Copy link
Member Author

ViktorHofer commented Jul 5, 2023 •
edited
Loading

@ericstj would you know the answer to my above question?

@ericstj
Copy link
Member

ericstj commented Jul 5, 2023

Here are the problems:

C:\src\dotnet\runtime\src\libraries\System.Private.CoreLib\src\System\Runtime\CompilerServices\ConfiguredAsyncDisposable.cs(21,45): error CS1591: Missing XML comment for publicly visible type or member 'ConfiguredAsyncDisposable.DisposeAsync()' [C:\src\dotnet\runtime\src\libraries\Microsoft.Bcl.AsyncInterfaces\src\Microsoft.Bcl.AsyncInterfaces.csproj::TargetFramework=netstandard2.0]
C:\src\dotnet\runtime\src\libraries\System.Private.CoreLib\src\System\Runtime\CompilerServices\ConfiguredCancelableAsyncEnumerable.cs(39,27): error CS1591: Missing XML comment for publicly visible type or member 'ConfiguredCancelableAsyncEnumerable<T>.GetAsyncEnumerator()' [C:\src\dotnet\runtime\src\libraries\Microsoft.Bcl.AsyncInterfaces\src\Microsoft.Bcl.AsyncInterfaces.csproj::TargetFramework=netstandard2.0]
C:\src\dotnet\runtime\src\libraries\System.Private.CoreLib\src\System\Runtime\CompilerServices\EnumeratorCancellationAttribute.cs(7,25): error CS1591: Missing XML comment for publicly visible type or member 'EnumeratorCancellationAttribute' [C:\src\dotnet\runtime\src\libraries\Microsoft.Bcl.AsyncInterfaces\src\Microsoft.Bcl.AsyncInterfaces.csproj::TargetFramework=netstandard2.0]
C:\src\dotnet\runtime\src\libraries\System.Private.CoreLib\src\System\Runtime\CompilerServices\EnumeratorCancellationAttribute.cs(9,16): error CS1591: Missing XML comment for publicly visible type or member 'EnumeratorCancellationAttribute.EnumeratorCancellationAttribute()' [C:\src\dotnet\runtime\src\libraries\Microsoft.Bcl.AsyncInterfaces\src\Microsoft.Bcl.AsyncInterfaces.csproj::TargetFramework=netstandard2.0]

So I'd put this on @dotnet/area-system-runtime-compilerservices

@ghost
Copy link

ghost commented Jul 5, 2023

Tagging subscribers to this area: @dotnet/area-system-runtime-compilerservices
See info in area-owners.md if you want to be subscribed.

Issue Details

See #84917 for more context.

The compiler generated XML file for Microsoft.Bcl.AsyncInterfaces is shipping to customers via the nuget package and is missing public API documentation. The above linked PR disables the compiler error CS1591 until all the API is documented.

When working on this, remove the NoWarn=1591 setting from the project file.

Author: ViktorHofer
Assignees: -
Labels:

documentation, area-System.Runtime.CompilerServices, help wanted
Milestone: 8.0.0

@ericstj ericstj self-assigned this Jul 5, 2023
@ericstj ericstj mentioned this issue Jul 5, 2023
Merged
@ghost ghost added the in-pr There is an active PR which will close this issue when it is merged label Jul 5, 2023
@ghost ghost removed the in-pr There is an active PR which will close this issue when it is merged label Jul 5, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Aug 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@ericstj ericstj

Labels
area-System.Runtime.CompilerServices 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
Milestone
8.0.0
Development

Successfully merging a pull request may close this issue.

Add docs for AsyncInterfaces ericstj/runtime
3 participants
@danmoseley @ViktorHofer @ericstj