How to deal with cross assembly crefs
- Dominant language
- C#
- Stars
- 14
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
I backported docs to System.IO as an experiment. It made FileSystemName (which is in corelib) have `` (which is in a different assembly). This is fine for the docs build because its context is apparently "everything". However the compiler complains with CS1574 and I have to remove the cref.
When making code the source of truth, how can we preserve cref's across assemblies?
@carlossanlop
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by examining how api-docs-sync handles triple-slash comments, IntelliSense XML, and cref values during the System.IO experiment. Reproduce the cross-assembly reference from FileSystemName to System.IO.FileSystemWatcher and compare the docs build with the compiler's CS1574 diagnostic. Done means the source-of-truth workflow preserves the reference without triggering that compiler error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100