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

Update package description used types for System.IO.Hashing #92859

Closed
wants to merge 1 commit into from

Conversation

xoofx
Copy link
Member

@xoofx xoofx commented Oct 1, 2023

While installing the NuGet package, the recently added types were not added to the csproj/NuGet description. This PR fixes this.

Should be probably backported to .NET 8 branch?

@ghost ghost added the community-contribution Indicates that the PR has been added by a community member label Oct 1, 2023
@ghost
Copy link

ghost commented Oct 1, 2023

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

Issue Details

While installing the NuGet package, the recently added types were not added to the csproj/NuGet description. This PR fixes this.

Should be probably backported to .NET 8 branch?

Author: xoofx
Assignees: -
Labels:

area-System.IO, community-contribution

Milestone: -

@stephentoub
Copy link
Member

@ViktorHofer, what's the guidance on which / how many types to list in the commonly used section?

@ViktorHofer
Copy link
Member

@ViktorHofer, what's the guidance on which / how many types to list in the commonly used section?

System.Text.Json's package readme lists seven "main types": https://github.com/dotnet/runtime/blob/main/src/libraries/System.Text.Json/src/PACKAGE.md#main-types

That list of types should highlight the most important types from the package so that consumers can directly use them in code or look them up on docs.microsoft.com. Enumerating all public types isn't the intention here. Hope that helps.

FWIW with the shift to package readmes, we stopped enumerating these types in the package description (not consistent yet). I see that System.IO.Hashing doesn't have a package readme yet.

@stephentoub
Copy link
Member

Thanks. Given that direction, seems like we should instead just be rewriting the readme, yes?

@ViktorHofer
Copy link
Member

Given that direction, seems like we should instead just be rewriting the readme, yes?

Yes, we should create a package readme for this package and update the package description. We could do that as part of #92228 or via a separate PR.

@xoofx
Copy link
Member Author

xoofx commented Oct 3, 2023

All good then if it is going to be handled more nicely, thanks!

@xoofx xoofx closed this Oct 3, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Nov 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.IO community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants