Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reconcile dotnet-api-docs descriptions with dotnet/runtime /// #10722

Open
gewarren opened this issue Jun 2, 2023 · 2 comments
Open

Reconcile dotnet-api-docs descriptions with dotnet/runtime /// #10722

gewarren opened this issue Jun 2, 2023 · 2 comments
Assignees
Labels
area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. doc-enhancement Improve the current content Pri1 Indicates issues/PRs that are high priority 📌 seQUESTered Identifies that an issue has been imported into Quest. untriaged New issue has not been triaged by the area owner

Comments

@gewarren
Copy link
Contributor

gewarren commented Jun 2, 2023

  1. 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.
  2. Copy the IntelliSense XML files to a branch in the binaries repo.
  3. 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.
  4. 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.
  5. Open each file that was modified and resolve all the conflicts.
  6. Run the CI pipeline to import the doc comments.
  7. Use https://github.com/dotnet/api-docs-sync/tree/main/src/PortToTripleSlash to port the comments back to ///.
  8. Open PRs in the dotnet/runtime repo.

Related items:

dotnet/runtime#44969
User Story 633174: [.NET] Partially import doc comments - Boards (azure.com)


Associated WorkItem - 97017

@gewarren gewarren self-assigned this Jun 2, 2023
@issues-automation issues-automation bot added the Pri3 Indicates issues/PRs that are low priority label Jun 2, 2023
@gewarren gewarren added Pri1 Indicates issues/PRs that are high priority doc-enhancement Improve the current content 🗺️ reQUEST Triggers an issue to be imported into Quest. and removed ⌚ Not Triaged Pri3 Indicates issues/PRs that are low priority labels Jun 2, 2023
@github-actions github-actions bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Jun 3, 2023
@gewarren gewarren changed the title Synchronize dotnet-api-docs descriptions to dotnet/runtime /// Renconcile dotnet-api-docs descriptions with dotnet/runtime /// Dec 7, 2023
@gewarren gewarren changed the title Renconcile dotnet-api-docs descriptions with dotnet/runtime /// Reconcile dotnet-api-docs descriptions with dotnet/runtime /// Dec 8, 2023
@gewarren gewarren transferred this issue from dotnet/docs Dec 4, 2024
@dotnet-issue-labeler dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Dec 4, 2024
Copy link

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Dec 4, 2024
Copy link

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@gewarren gewarren added the area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. label Dec 4, 2024
@eiriktsarpalis eiriktsarpalis removed the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. doc-enhancement Improve the current content Pri1 Indicates issues/PRs that are high priority 📌 seQUESTered Identifies that an issue has been imported into Quest. untriaged New issue has not been triaged by the area owner
Projects
No open projects
Status: Slipped
Status: Slipped
Status: Slipped
Status: Slipped
Development

No branches or pull requests

3 participants