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

fix markdown lint issues #41888

Merged
merged 2 commits into from
Jul 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/csharp/language-reference/xmldoc/recommended-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,15 +256,17 @@ The `<para>` tag is for use inside a tag, such as [\<summary>](#summary), [\<rem
</list>
```

The `<listheader>` block is used to define the heading row of either a table or definition list.
The `<listheader>` block is used to define the heading row of either a table or definition list.

When defining a table:
* You only need to supply an entry for `term` in the heading.

* You only need to supply an entry for `term` in the heading.
* Each item in the list is specified with an `<item>` block. For each `item`, you will only need to supply an entry for `description`.

When creating a definition list:
* You must supply an entry for `term` in the heading.
* Each item in the list is specified with an `<item>` block. Each `item` must contain both a `term` and `description`.

* You must supply an entry for `term` in the heading.
* Each item in the list is specified with an `<item>` block. Each `item` must contain both a `term` and `description`.

A list or table can have as many `<item>` blocks as needed.

Expand Down
Loading