dotnet / dotnet/api-docs-sync

Don't indent remarks

未关闭
#84 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
port-to-docs
主要语言
C#
星标
14
派生
21
PR 合并指标
30 天内没有已合并 PR

描述

When remarks get indented by 4 spaces, they're rendered as code blocks. For example, [this PR](https://github.com/dotnet/dotnet-api-docs/pull/7054/files) introduced indentation that caused the remarks to render as code blocks. A customer fixed that in https://github.com/dotnet/dotnet-api-docs/pull/7104. The /// for the remarks is [here](https://github.com/dotnet/runtime/blob/36b6247cc7743dda997e9d671175ddc2b3e030ba/src/coreclr/System.Private.CoreLib/src/System/Runtime/DependentHandle.cs#L15) - perhaps the `` tags are causing the indentation.

贡献指南

这个仓库没有索引到贡献指南

调研方向

将链接的 PR 7054 和 7104 与 DependentHandle.cs 中的三斜线注释进行比较,然后跟踪处理 标签和缩进的 api-docs-sync 转换流程。完成的标准是注释不再增加四个空格的缩进,并呈现为代码块。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp
领域
documentation, tooling
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。