-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Open
Labels
📌 seQUESTeredIdentifies that an issue has been imported into Quest.Identifies that an issue has been imported into Quest.Pri1Indicates issues/PRs that are high priorityIndicates issues/PRs that are high priorityarea-MetaConcerns something that extends across runtime area boundaries, for example, IDisposable.Concerns something that extends across runtime area boundaries, for example, IDisposable.doc-enhancementImprove the current contentImprove the current contentuntriagedNew issue has not been triaged by the area ownerNew issue has not been triaged by the area owner
Description
- Generate IntelliSense XML files for each namespace in dotnet/runtime (see instructions below) - use a specific tag so all APIs already exist in dotnet-api-docs.
- Copy the IntelliSense XML files to a branch in the binaries repo.
- Consider (temporarily) reformatting all the ECMAXML files if this generates less noise in the IntelliSense files.
- CLI:
find . -name "*.xml" -type f | xargs -I'{}' xmllint --output '{}' --format '{}'
(but this tool might do unwanted things) - VS Code extension (Red Hat XML) with xml.format.maxlinewidth set to 0 (disable) - sample PR is here.
- CLI:
- Use the doc comment resolver tool in dotnet/docs-tools to update the IntelliSense files with any conflicting text from the dotnet-api-docs repo.
- Open each file that was modified and resolve all the conflicts.
- Run the CI pipeline to import the doc comments.
- Use https://github.com/dotnet/api-docs-sync/tree/main/src/PortToTripleSlash to port the comments back to ///.
- Open PRs in the dotnet/runtime repo.
Related items:
dotnet/runtime#44969
User Story 633174: [.NET] Partially import doc comments - Boards (azure.com)
Metadata
Metadata
Assignees
Labels
📌 seQUESTeredIdentifies that an issue has been imported into Quest.Identifies that an issue has been imported into Quest.Pri1Indicates issues/PRs that are high priorityIndicates issues/PRs that are high priorityarea-MetaConcerns something that extends across runtime area boundaries, for example, IDisposable.Concerns something that extends across runtime area boundaries, for example, IDisposable.doc-enhancementImprove the current contentImprove the current contentuntriagedNew issue has not been triaged by the area ownerNew issue has not been triaged by the area owner