Update System.Formats.Tar docs #75386
Conversation
carlossanlop
added
documentation
|
Tagging subscribers to this area: @dotnet/area-system-io Issue DetailsSync triple slash with the docs reviewed docs: dotnet/dotnet-api-docs#8375
|
|
There were suggestions provided in the dotnet-api-docs PR. Need to backport them here. |
| /// <summary> | ||
| /// Initializes a new <see cref="GnuTarEntry"/> instance with the specified entry type and entry name. | ||
| /// </summary> | ||
| /// <remarks>When creating an instance using the <see cref="GnuTarEntry(TarEntryType, string)"/> constructor, only the following entry types are supported: <see cref="TarEntryType.Directory"/>, <see cref="TarEntryType.HardLink"/>, <see cref="TarEntryType.SymbolicLink"/>, <see cref="TarEntryType.RegularFile"/> <see cref="TarEntryType.BlockDevice"/>, <see cref="TarEntryType.CharacterDevice"/> and <see cref="TarEntryType.Fifo"/>.</remarks> |
There was a problem hiding this comment.
Just curious why the remarks section moved up?
| /// Gets or sets the ID of the user that owns the file represented by this entry. | ||
| /// </summary> | ||
| /// <remarks>This field is only supported in Unix platforms.</remarks> | ||
| /// <remarks>This field is only used in Unix platforms.</remarks> |
There was a problem hiding this comment.
"This field"... this isn't a field, it's a property.
| { | ||
| /// <summary> | ||
| /// Reads a tar archive from a stream. | ||
| /// Reads a TAR archive from a stream. |
There was a problem hiding this comment.
All of these tars were made TARs. I very rarely see "tar" capitalized as an acronym, e.g. wikipedia uses "tar" rather than "TAR" when talking about "tar archives":
https://en.wikipedia.org/wiki/Tar_(computing)
We've decided to go a different way?
|
I'll close this and will resubmit when we focus on the docs backporting effort. |
ghost
locked as resolved and limited conversation to collaborators
3 participants
Sync triple slash with the docs reviewed docs: dotnet/dotnet-api-docs#8375