linksplatform / linksplatform/Memory

DocFX fails to inherit indexer comments

Open
#16 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

https://github.com/linksplatform/Memory/blob/ac233104cb63a2b8f27e72bc9e62cba2319d367f/DirectMemoryAsArrayMemoryAdapter.cs#L34
[Documentation link](https://linksplatform.github.io/Memory/csharp/api/Platform.Memory.DirectMemoryAsArrayMemoryAdapter-1.html#Platform_Memory_DirectMemoryAsArrayMemoryAdapter_1_Item_System_Int64_)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with DirectMemoryAsArrayMemoryAdapter.cs at line 34 and compare its comments with the linked generated API page. Investigate how DocFX handles the indexer there; done means the generated documentation includes the inherited indexer comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.