godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

Clarify and add to C# API general differences

Open 31 opened this issue 2 years ago • 0 comments

First, make the link back to the C# basics page more specific. This gets past the setup sections and maybe even gets new eyes on the Gotchas section and other warnings just below it.

Here's my logic for the rest:

  • Explain more specifically that PascalCase is how the APIs are accessed. This whole paragraph has been misinterpreted by a few people in the Godot C# help Discord channel:
    • As a casual note about general C# style,
    • As a requirement that their custom class methods/properties must be PascalCase.
  • Copy over the rest of that C# basics section. It doesn't seem right to me to be less detailed on the more specific page. (I would skip this link because I assume I'm already reading the detailed page.)
  • Explicitly mention that C# doesn't include the setters/getters that GDScript is able to call. This can make things hard to find, especially if you're coming from Godot 3.x GDScript -> Godot 4.x C#, and especially if that means you're trying to use the Godot editor for C#--no intellisense. (I've had to point this out to a number of people trying to translate GDScript.)
  • On that note: add a note about how nice intellisense is in dealing with the general differences. I was thinking this might seem a little out of place... but really it's quite important to effectively use the C# API. I tried my best with the tone, but I'm not totally sure it's ok in this context.

31 avatar Feb 10 '24 09:02 31