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

Add notes for common C# bugs on Windows #5985

Merged
merged 1 commit into from
Jul 27, 2022

Conversation

31
Copy link
Contributor

@31 31 commented Jul 24, 2022

Add notes for a few C# bugs that we see often in the C# Discord channel.


First, mention the issues with the Visual Studio extension. This has been a problem for a while (Aug 27, 2020, Godot 3.2.3) and I think it's worth pointing it out here, where it might help inform people's choice of editor, or at least let them know that they aren't alone in having this problem and show how they might be able to work around it.

I also changed "you need to download the Godot Visual Studio extension from github" to "you can download" because it is not required, and some people are happy to use Visual Studio with Godot even without the extension working.


Second, a fix for a NuGet behavior that we also see often in the C# Discord where the user's default NuGet.Config file loses its nuget.org source. I have suspicions that it comes from a Visual Studio update issue, but all I know is that I've only seen it happen on Windows and some people who hit it knew they were using Visual Studio.

I'm not totally sure this section is the right place for it, but I haven't noticed a more general troubleshooting section that it might fit into better.


This applies to 3.x.

@skyace65
Copy link
Contributor

skyace65 commented Jul 25, 2022

I'm not a heavy C# user so correct me if I'm wrong or there's an angle I'm missing, but considering the current state of the visual studio extension wouldn't it make more sense to just remove any reference to it at this point? It is functionally broken and from what I'm seeing the workaround causes other issues described here.

@skyace65
Copy link
Contributor

Also for future reference, don't make two different PR's for the same page on the same branch. Do it all in one PR. We don't mind that it's covering multiple issues, and since it's split you'll have to rebase one of them after one gets merged.

@31
Copy link
Contributor Author

31 commented Jul 25, 2022

I pushed some changes to improve the wording (IMO 🙂) and remove the mention of 3.2.3. I also directly link the comment containing the workaround for VS2019 rather than telling people to read through the whole thread.

Something I'm unclear on is whether the workaround works in VS 2022 or just VS 2019. Someone on the 2022 thread said it does for them, but others in the C# Discord channel and on some gists say it doesn't, or that it seems to at first and then breaks later. That's why the sentence about VS2022 is a little vague--because I don't know if the workaround also works there. If people see this note, maybe they will report their findings on the VS2022 issue. I figure being vague until then is reasonable.

We don't mind that it's covering multiple issues, and since it's split you'll have to rebase one of them after one gets merged.

I made sure before submitting that the PRs won't conflict as far as Git goes, or is there a more restrictive limit in this repo?

(I actually originally had these two notes split up into two branches because they aren't actually all that related, but I combined them because Git would have considered that particular split to be a conflict. 😄 Avoiding conflict resolution and rereview does make sense to me in general, and I'd be happy to optimize in that direction.)

@31
Copy link
Contributor Author

31 commented Jul 25, 2022

I'm not a heavy C# user so correct me if I'm wrong or there's an angle I'm missing, but considering the current state of the visual studio extension wouldn't it make more sense to just remove any reference to it at this point?

I'm not really sure where to set the bar on that. In theory, someone might have a strong enough preference for Visual Studio to specifically install VS 2019 and use the workaround in order to get debugging working in their IDE of choice. I don't know how to weigh that vs. the untidiness of the doc pointing to a known-broken tool and not-necessarily-working workarounds.

(Thanks for the link to godotengine/godot-csharp-visualstudio#26, I'd forgotten about that one!)

@mhilbrunner mhilbrunner merged commit 420ed27 into godotengine:master Jul 27, 2022
@mhilbrunner
Copy link
Member

Thank you, great work! 🎉

@31 31 deleted the dev/31/winbugs branch July 27, 2022 01:02
mhilbrunner added a commit that referenced this pull request Aug 8, 2022
Add notes for common C# bugs on Windows

(cherry picked from commit 420ed27)
mhilbrunner added a commit that referenced this pull request Aug 8, 2022
Add notes for common C# bugs on Windows

(cherry picked from commit 420ed27)
@mhilbrunner
Copy link
Member

Cherry-picked to 3.4 and 3.5.

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

Successfully merging this pull request may close these issues.

6 participants