dotnet / dotnet/api-docs-sync

Lists should be rendered with <item>

Open
#61 1 comment 0 reactions 0 assignees View on GitHub
port-to-tripleslash
Dominant language
C#
Stars
14
Forks
21
PR merge metrics
No merged PRs in 30d

Description

As suggested here: https://github.com/dotnet/runtime/pull/46716#discussion_r585230663

Lists should be rendered with ``

Example: https://github.com/dotnet/roslyn/blob/b09625add4da1b872e8033d2775ea514786d86e1/src/Features/Core/Portable/DocumentationComments/AbstractDocumentationCommentFormattingService.cs#L43-L56

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the discussion in dotnet/runtime PR 46716 and compare the Roslyn example at AbstractDocumentationCommentFormattingService.cs lines 43-56. Locate the list-rendering path in api-docs-sync and verify that its output uses ; done means list documentation is rendered consistently with the referenced example.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.