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

missing help for some source generator errors #35297

Closed
danmoseley opened this issue May 10, 2023 · 11 comments
Closed

missing help for some source generator errors #35297

danmoseley opened this issue May 10, 2023 · 11 comments
Labels
🏁 Release: .NET 8 Work items for the .NET 8 release doc-enhancement Improve the current content [org][type][category] Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@danmoseley
Copy link
Member

danmoseley commented May 10, 2023

https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib1040-1049
https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib1050-1069
https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib1070-1089

exist, but nothing for the Com interop source generator eg SYSLIB1090 nor the Config source generator eg SYSLIB1100

the live list of what the implementation has is
https://github.com/dotnet/runtime/blob/main/docs/project/list-of-diagnostics.md?plain=1#L210

@gewarren not sure whether this issue should be here or dotnet/docs, as presumably dev need to supply the text.

related dotnet/runtime#85181


Associated WorkItem - 89919

@gewarren
Copy link
Contributor

@danmoseley I think this should be transferred to the dotnet/docs repo.

@ghost
Copy link

ghost commented May 10, 2023

Tagging subscribers to this area: @dotnet/area-system-runtime
See info in area-owners.md if you want to be subscribed.

Issue Details

https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib1040-1049
https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib1050-1069
https://learn.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib1070-1089

exist, but nothing for the Com interop source generator eg SYSLIB1090 nor the Config source generator eg SYSLIB1100

the live list of what the implementation has is
https://github.com/dotnet/runtime/blob/main/docs/project/list-of-diagnostics.md?plain=1#L210

@gewarren not sure whether this issue should be here or dotnet/docs, as presumably dev need to supply the text.

related dotnet/runtime#85181

Author: danmoseley
Assignees: -
Labels:

area-System.Runtime, untriaged, needs-area-label

Milestone: -

@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label May 10, 2023
@danmoseley danmoseley transferred this issue from dotnet/runtime May 10, 2023
@danmoseley
Copy link
Member Author

as mentioned in linked issue, the product should link to https://learn.microsoft.com/dotnet/fundamentals/syslib-diagnostics/<CODE>.md and docs should either have a page for each or use redirection to a different page that groups several.

this issue tracks adding the content, which should be supplied by the owners of the COM Interop source generator (@jkoritzinsky ?) and he configuration source generator (@layomia )

@gewarren gewarren added doc-idea Indicates issues that are suggestions for new topics [org][type][category] 🏁 Release: .NET 8 Work items for the .NET 8 release and removed ⌚ Not Triaged Not triaged Pri3 labels May 10, 2023
@gewarren gewarren added the Pri1 High priority, do before Pri2 and Pri3 label May 10, 2023
@gewarren gewarren added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label May 10, 2023
@gewarren gewarren self-assigned this May 10, 2023
@gewarren gewarren moved this from 🔖 Ready to 🏗 In progress in dotnet/docs May 2023 sprint May 11, 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 May 11, 2023
@gewarren
Copy link
Contributor

@gewarren gewarren removed their assignment May 19, 2023
@gewarren gewarren moved this from 🏗 In progress to ✅ Done in dotnet/docs May 2023 sprint May 19, 2023
@gewarren gewarren added doc-enhancement Improve the current content [org][type][category] and removed doc-idea Indicates issues that are suggestions for new topics [org][type][category] labels Jul 18, 2023
@danmoseley
Copy link
Member Author

Cc @ericstj as owner of the config generator in case there is more to add.
Otherwise maybe we can close.

@ericstj
Copy link
Member

ericstj commented Oct 19, 2023

@dotnet/area-extensions-configuration for configuration - folks can improve the doc if they see opportunity.

I see we're missing the ones added for options validation @dotnet/area-extensions-options and some new ones added for JSON @dotnet/area-system-text-json

https://github.com/dotnet/runtime/blob/bb3597aeaaeb87920b848e71a7b152a202e672bd/docs/project/list-of-diagnostics.md?plain=1#L238-L266

@danmoseley
Copy link
Member Author

@jkoritzinsky do the interop ones look OK?

@tarekgh
Copy link
Member

tarekgh commented Oct 24, 2023

I have created a PR for options source gen conceptual doc #37681. I'll try to look at the diagnostics doc to see what is missing and add it.

@tarekgh
Copy link
Member

tarekgh commented Oct 24, 2023

I have created the PR #37686 to address the Configuration and Options diagnostics.

@tarekgh
Copy link
Member

tarekgh commented Oct 24, 2023

#37686 is not completed. Thanks @gewarren for your review and feedback

@gewarren
Copy link
Contributor

AFAICT, all SYSLIB diagnostics are now documented.

@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in .NET 8.0 work items Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏁 Release: .NET 8 Work items for the .NET 8 release doc-enhancement Improve the current content [org][type][category] Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
No open projects
Status: Done
Status: Done
Development

No branches or pull requests

5 participants