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

Unify C# naming notes and comments #9075

Merged
merged 1 commit into from
Mar 10, 2024

Conversation

skyace65
Copy link
Contributor

Doing this because of discussion in #9048.

Currently there's a note in the first 2D game tutorial about naming, the first 3D game has comments in all of its code for signals, and the signals page in step by step has nothing. This PR makes it so all sections have a note and code comments. The notes are being used in addition to comments since comments can't be translated. Technically we could have the note just in the signals page, since you're supposed to read that before either of the first game tutorials, but I don't think we should assume people won't skim or skip around. Plus if someone's going through these pages over multiple days and not in one day it's good to have reminders.

Closes #9048.

@skyace65 skyace65 added enhancement topic:dotnet area:getting started Issues and PRs related to the Getting Started section of the documentation cherrypick:4.2 labels Mar 10, 2024
getting_started/first_2d_game/03.coding_the_player.rst Outdated Show resolved Hide resolved
getting_started/step_by_step/signals.rst Outdated Show resolved Hide resolved
getting_started/step_by_step/signals.rst Outdated Show resolved Hide resolved
@skyace65
Copy link
Contributor Author

skyace65 commented Mar 10, 2024

Fixed. I've also added a period to the code comments in the first 3D game that I was copying from.

Copy link
Member

@raulsntos raulsntos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for taking care of this 👍

@mhilbrunner mhilbrunner merged commit 13ce923 into godotengine:master Mar 10, 2024
1 check passed
@mhilbrunner
Copy link
Member

Thank you! 🎉

@mhilbrunner
Copy link
Member

Cherry-picked to 4.2 in #9648.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:getting started Issues and PRs related to the Getting Started section of the documentation enhancement topic:dotnet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing part in the step by step guide
4 participants