Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
#182 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

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.

Dominant language
C#
Stars
14
Forks
21
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/api-docs-sync

All issues in dotnet/api-docs-sync

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.