dotnet / dotnet/api-docs-sync

Too many \<para> tags added when importing docs from IntelliSense

Open
#175 0 comments 0 reactions 1 assignee Claimed by @carlossanlop View on GitHub
Dominant language
C#
Stars
14
Forks
21
PR merge metrics
No merged PRs in 30d

Description

`` tags should probably only be added around full sentences that are followed by a line break, not each individual line.

Example /// [source remarks](https://github.com/dotnet/runtime/blob/f2f3133fbeefbb72c0bd56207d5d7df43e9a8182/src/libraries/System.Text.Json/src/System/Text/Json/Serialization/Metadata/JsonPropertyInfo.cs#L364-L371).

Example [ECMAXML](https://github.com/dotnet/dotnet-api-docs/blob/ada2cc15da15a6b99ae12e5facc085f0a2b9d9cf/xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfo.xml#L59-L63).

[How it renders](https://learn.microsoft.com/en-us/dotnet/api/system.text.json.serialization.metadata.jsonpropertyinfo.associatedparameter?view=net-8.0#remarks) (with extra blank lines).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.