dotnet / dotnet/api-docs-sync

When a type is marked `forInternalUseOnly` no docs should be ported

Open
#182 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
14
Forks
21
PR merge metrics
No merged PRs in 30d

Description

See https://github.com/dotnet/dotnet-api-docs/pull/11876/files#diff-b0ae656814a099739c4fe0a46da61348a8a4c558613d7f49cf6607babfa061ec

We shouldn't be porting these internal remarks, however we should keep them in source since they are valuable for developers working on RegEx.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked pull request diff and trace how a type marked `forInternalUseOnly` is handled during documentation porting. Done means internal remarks remain in source but are omitted from the ported API docs; the payload names no test, file, or entry point to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.