dotnet/roslyn

Pasting generic type names in doc comments should escape '<' and '>'

Open

#19,197 opened on May 3, 2017

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C# (4,257 forks)batch import
Area-IDEhelp wanted

Repository metrics

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

Description

I find myself often passing type names into <see cref=""/> constructs, it would be so helpful if the '<' and `>' would be automatically replaced with '{' and '}'.

Contributor guide

Research direction
Locate the code that handles doc comment generation and modify the escaping of '<' and '>' to '{' and '}'.
Tech stack
csharp
Domain
documentation
Issue type
Feature
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#Roslyn
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65