dotnet / dotnet/fsharp

XmlDoc is displayed along with the summary tag

Open
#11,611 3 comments 1 reaction 0 assignees View on GitHub
Area-FCS Bug Impact-Low
Dominant language
F#
Stars
4.3k
Forks
876
Avg merge
4d 11h
Merged PRs (30d)
131

Description

Rider uses `FSharpXmlDoc.FromXmlText(xmlDoc) -> xmlDoc.UnprocessedLines` to get xml documentation text.
And if earlier for library entities there was a summary inner text there, then, apparently after https://github.com/dotnet/fsharp/pull/11454, `UnprocessedLines` contains text along with the summary tag, which looks like a regression.

Rider 2021.1 (old behavior)
![image](https://user-images.githubusercontent.com/26364714/120023146-13cd1700-bff6-11eb-9fb0-171e333aa1ee.png)

Rider 2021.2 Dev (new behavior)
![image](https://user-images.githubusercontent.com/26364714/120023194-20ea0600-bff6-11eb-8173-dd4afe75afa2.png)

It seems to me it has something to do with how the documentation is read here
https://github.com/dotnet/fsharp/pull/11454/files#diff-56fbb9330ceb81afbfa2ea19c8b4bb3946a732f8ffb128f0d1435884808e06e8R250

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.