For types that live in a difference assembly than the one that ships it, make sure the MSBuild task will move them to the appropriate intellisense xml

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
documentation, tooling

Research direction

Start at the MSBuild task that processes IntelliSense XML and trace how it chooses the destination assembly. Use the String example to verify that documentation from System.Private.CoreLib.xml is moved to System.Runtime.xml. Done means types whose implementation assembly differs from their shipping assembly appear in the appropriate IntelliSense XML.

Written by the indexing model from the issue text.

Description

port-to-tripleslash

For example, String lives in System.Private.CoreLib.xml, move its docs to System.Runtime.xml

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.