dotnet / dotnet/api-docs-sync

Missing mapping with ToDocs command

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

描述

When I worked on https://github.com/dotnet/dotnet-api-docs/pull/7129 the DocsPortingTool didn't map some methods to xml files. I had to do it manually.

- `M:System.Net.Http.HttpRequestOptions.TryGetValue``1(System.Net.Http.HttpRequestOptionsKey{``0},``0@)`
- `M:System.Net.Http.HttpRequestOptions.Set``1(System.Net.Http.HttpRequestOptionsKey{``0},``0)`

The command I used was `DocsPortingTool -Direction ToDocs -Docs c:\Dev\dotnet-api-docs\xml -IntelliSense C:\dev\runtime\artifacts\bin\System.Net.Http\ -IncludedAssemblies System.Net.Http -IncludedNamespaces System.Net.Http -Save true` on this code https://github.com/dotnet/runtime/pull/58896/files

贡献指南

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

调研方向

首先,复现与 System.Net.Http 程序集以及列出的 XML 和 IntelliSense 路径一起显示的 DocsPortingTool 命令。使用所引用的 runtime pull request 中的源签名,调查 ToDocs 命令如何映射两个通用的 HttpRequestOptions 方法。完成的标准是两个方法都能自动映射到其 XML 文档文件。

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

评估

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

把新 issue 发到你的邮箱

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