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

Fix latest VS compatibility #4591

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Fix latest VS compatibility #4591

merged 1 commit into from
Jul 30, 2024

Conversation

MaceWindu
Copy link
Contributor

No description provided.

@MaceWindu MaceWindu merged commit 5aeed93 into master Jul 30, 2024
1 of 3 checks passed
@MaceWindu MaceWindu deleted the infra/fix_build_issues branch July 30, 2024 10:20
@jods4
Copy link
Contributor

jods4 commented Jul 30, 2024

@MaceWindu wouldn't it be better to remove the rule that requires xml doc comments on public API for the code generator project, rather than adding empty comments on everything?

@MaceWindu
Copy link
Contributor Author

dotnet/roslyn#41640 😄

@jods4
Copy link
Contributor

jods4 commented Jul 30, 2024

😮 that issue looks like a mess!

@MaceWindu
Copy link
Contributor Author

Anyway, need to submit another pr, looks like roslyn cannot locate generators from artifacts folder now...

@Shane32
Copy link
Contributor

Shane32 commented Jul 30, 2024

Personally, I would not insert empty xml comments just to remove unnecessary usings. Unnecessary usings does not hurt any code. Empty XML comments does. Either (a) when you want to require XML comments, they are not flagged as errors, or (b) they mask auto-inherited comments. Further, I'm not sure why there is any valid reason to add a public member without an XML comment. It only takes a few seconds to write an applicable XML comment, and ChatGPT can draft code comments for entire classes extremely quickly. Besides documentation being lacking for linq2db in general, one of the biggest issues with the linq2db codebase was the lack of commenting the internal workings. Without comments, usually effective at the method level, it becomes very difficult to understand the purpose and logic of the code flow, severely limiting my and other contributors' ability to provide bug fixes. I've not been involved much recently with v6, so hopefully we have much more comments now. I've spent extensive time with other open-source projects to write XML comments for all public API members (and often internal members), but I have not had the spare time to try to tackle linq2db. Just my two cents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants