dotnet/roslyn

Auto-generated operations should handle multi-line doc comments correctly

Open

#54,900 opened on Jul 17, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-CompilersConcept-Continuous Improvementhelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

Version Used:

main

Steps to Reproduce:

image

This renders as a single line:

image

Either have the source generator add <para> on its own, or do that in OperationInterfaces.xml

The above is just an example. This may apply to other doc comments

Contributor guide

Research direction
Examine the source generator output for doc comments and ensure multi line comments include `<para>` tags or adjust the XML template to handle them.
Tech stack
csharp
Domain
compilers
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70