System.Formats.Cbor package's readme #93021
Conversation
Removed since is not applicable
Add list of types which library provides. Listed public types, means exposed types.
Add library description. Add few code examples showing basic functionality for CBOR wirter and reader types.
Since different targets have different dependencies so I have divided for each section.
Add 'format' word after abbreviation to have an object in sentence.
ghost
added
the
community-contribution
|
Tagging subscribers to this area: @dotnet/area-system-security, @bartonjs, @vcsjones Issue DetailsAdding PACKAGE.md for System.Formats.Cbor package. Progress towards #92228.
|
| * Provides HashCode types: [Microsoft.Bcl.HashCode](https://www.nuget.org/packages/Microsoft.Bcl.HashCode/) | ||
| * Resource pooling: [System.Buffers](https://www.nuget.org/packages/System.Buffers/) | ||
| * Efficient memory representation: [System.Memory](https://www.nuget.org/packages/System.Memory/) | ||
| * Provides functionality over pointers: [System.Runtime.CompilerServices.Unsafe](https://www.nuget.org/packages/System.Runtime.CompilerServices.Unsafe/) | ||
| * Provides underlying type for tuples: [System.ValueTuple](https://www.nuget.org/packages/System.ValueTuple/) |
There was a problem hiding this comment.
What makes these "related"? Based on the fact that it's using TFMs here suggests it's "dependencies", but that's already data that gets surfaced, so why would it be in the description?
I'd, personally, expect this to be more for "this is the primitive layer, but if you want a friendly, opinionated view of a thing that's easier to work with, see [something else]". I don't think there's anything like that with CBOR, so I'd, personally, say there are no "related" packages.
There was a problem hiding this comment.
I was looking at this section more like "dependencies" packages for some reason. I am aware that user can see dependencies clicking on "Dependencies" tab.
Overall, you are right! Perhaps, I have misunderstood the purpose of this section. Are you okay if I remove the section completely? I can not list any related packages.
Since there are no related packages.
ViktorHofer
merged commit 37120cd
into
dotnet:PackageReadmesContinued
* Remove conceptual docummentation item Removed since is not applicable * List types library provides Add list of types which library provides. Listed public types, means exposed types. * Add description and usage examples Add library description. Add few code examples showing basic functionality for CBOR wirter and reader types. * Add related packages section Since different targets have different dependencies so I have divided for each section. * Improve short description Add 'format' word after abbreviation to have an object in sentence. * Remove related packages section Since there are no related packages. * Improve array reading/writing example
ghost
locked as resolved and limited conversation to collaborators
Adding PACKAGE.md for System.Formats.Cbor package.
Progress towards #92228.