<see langword="..."/> renders as nothing in API docs
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 78/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- fsharp
调研方向
从 src/FSharp.Formatting.ApiDocs/XmlDocReader.fs 第193–213行的 see 和 seealso 处理逻辑开始。检查读取器如何处理 cref，以及 c 元素如何转换为行内代码，然后跟进相关的 API 文档测试。完成标准是：true 之类的 langword 值会显示为行内代码，而不是消失。
由索引模型根据 Issue 内容生成。
描述
XmlDocReader renders a <see> or <seealso> element only when it has a cref attribute (XmlDocReader.fs#L193-L213). <see langword="true"/>, the .NET way to reference a keyword, has no cref, so the word is lost: /// <summary>Returns <see langword="true"/> when the event has at least one handler.</summary> renders as "Returns when the event has at least one handler." The expected output is the keyword as inline code, the same as <c>true</c>.
FSharp.Core starts to use langword in dotnet/fsharp#20940, so its API reference shows the gap.
- 主要语言
- F#
- 星标
- 492
- 派生
- 160
- 平均合并
- 3 天 2 小时
- 30 天内合并 PR
- 7
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
fsprojects/FSharp.Formatting 的其他 Issue
-
enhancement help wanted
难度 5/5 一周以上 新手友好度 25/100
fsprojects/FSharp.Formatting#1064 · 1 条评论 ·
维护者通常 1 天内回复
-
enhancement
难度 5/5 一周以上 新手友好度 35/100
fsprojects/FSharp.Formatting#929 · 8 条评论 · 13 个 reaction ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 48/100
fsprojects/FSharp.Formatting#928 · 18 条评论 ·
维护者通常 1 天内回复
-
Nesting Document Categories可能重新可做 关联的 PR 已关闭且未合并。 未关闭enhancement needs-community-interest
难度 5/5 一周以上 新手友好度 35/100
fsprojects/FSharp.Formatting#927 · 7 条评论 ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
fsprojects/FSharp.Formatting#898 · 1 条评论 ·
维护者通常 1 天内回复
查看 fsprojects/FSharp.Formatting 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
obsidianmd/obsidian-help#1169 ·
维护者通常 2 天内回复
-
[docs] RELEASE.md: wrong branch name, no check that the prepare PR merged with the right subject, manual publish step可能已有人在做 @albertteoh 今天认领。 未关闭documentation
难度 2/5 1-3 小时 新手友好度 85/100
jaegertracing/jaeger-ui#4739 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
Document and enforce pull request review guidelines可能已有人在做 @dashorst 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100