Some markdown-formatted remarks are ported into triple slash comments with invalid structure
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 42/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- csharp
- 領域
- documentation, tooling
調査の方向性
MemoryManager`1.xml の remarks と、issue に示されている生成結果の MemoryManager.cs のトリプルスラッシュコメントを比較します。remarks 要素と format 要素を処理するドキュメント移植経路を追跡し、生成された remarks が重複した内容を含まず、有効な構造になっていることを確認します。
索引モデルが issue の本文から書いたものです。
説明
As seen in MemoryManager<T> from System.Memory in dotnet/runtime, some <remarks> sections are getting produced with invalid structure, and duplicated content.
From `MemoryManager`1.xml`
<Docs>
<typeparam name="T">The type of items in the memory buffer managed by this memory manager.</typeparam>
<summary>An abstract base class that is used to replace the implementation of <see cref="T:System.Memory`1" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
The `MemoryManager<T>` class is used to extend the knowledge of types that <xref:System.Memory%601> is able to represent. For example, you can derive from `MemoryManager<T>` to allow <xref:System.Memory%601> to be backed by a <xref:System.Runtime.InteropServices.SafeHandle>.
> [!NOTE]
> The `MemoryManager<T>` class is intended for advanced scenarios. Most developers do not need to use it.
]]></format>
</remarks>
</Docs>
Before porting the docs into triple slash comments, this was the content of MemoryManager.cs:
/// <summary>
/// Manager of <see cref="System.Memory{T}"/> that provides the implementation.
/// </summary>
public abstract class MemoryManager<T> : IMemoryOwner<T>, IPinnable
After porting, this is the result:
/// <summary>An abstract base class that is used to replace the implementation of <see cref="System.Memory{T}" />.</summary>
/// <typeparam name="T">The type of items in the memory buffer managed by this memory manager.</typeparam>
/// <remarks>The `MemoryManager<T>` class is used to extend the knowledge of types that <see cref="System.Memory{T}" /> is able to represent. For example, you can derive from `MemoryManager<T>` to allow <see cref="System.Memory{T}" /> to be backed by a <see cref="System.Runtime.InteropServices.SafeHandle" />.
/// <format type="text/markdown"><![CDATA[
/// > [!NOTE]
/// > The `MemoryManager<T>` class is intended for advanced scenarios. Most developers do not need to use it.
/// ]]></format></remarks>
public abstract class MemoryManager<T> : IMemoryOwner<T>, IPinnable
The <remarks> section has the content duplicated, once inside the <format> and once before it, which is an invalid structure.
- 主要言語
- C#
- スター
- 14
- フォーク
- 22
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dotnet/api-docs-sync のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
dotnet/api-docs-sync#182 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
dotnet/api-docs-sync#181 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
dotnet/api-docs-sync#180 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
dotnet/api-docs-sync#179 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
dotnet/api-docs-sync#178 · コメント 1 件 ·
dotnet/api-docs-sync の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
reactiveui/ReactiveUI.Binding.SourceGenerators#176 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
lugassawan/swe-workbench#799 ·
メンテナーはふだん 1 日以内に返信
-
.NET Docs Next Major
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
getsentry/sentry-dotnet#5709 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
plengauer/RicherPresence#132 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
QuantConnect/Lean#9889 ·
メンテナーはふだん 1 日以内に返信