search

dotnet / docs

This repository contains .NET Documentation.
https://learn.microsoft.com/dotnet
Creative Commons Attribution 4.0 International
4.16k stars 5.83k forks source link

<list> documentation #41486

Open gggustafson opened 1 week ago

gggustafson commented 1 week ago

Type of issue

Missing information

Description

[Enter feedback here] Documentation on <list> is confusing. There is suddenly a "definition list" discussed that is not in the type parameter. I know how to generate numbered list <ol>, a bulleted list <ul>, and a table <table>. But the discussion of the <list> components is confusing. In a <table> I expect as many <th>s and <td>s as there are entries in the <listheader>. I expect as many <tr>s as there are <item>s. I suggest a rewrite of this section.

Page URL

https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#general-tags

Content source URL

https://github.com/dotnet/docs/blob/main/docs/csharp/language-reference/xmldoc/recommended-tags.md

Document Version Independent Id

d135d0a6-53d2-1567-0b1b-7aae5e07739f

Article author

@BillWagner

Metadata

gggustafson commented 6 days ago

Should have C# XML-comments as tags