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 c# script name note to scripting_first_script.rst #8732

Merged
merged 1 commit into from
Jan 10, 2024

Conversation

a-johnston
Copy link
Contributor

Adds a short note regarding C# script naming. This is a somewhat common point of confusion for newer users. Please let me know if I should update the wording here to be clearer/more precise.

@raulsntos
Copy link
Member

There's a note about this in the C# basics documentation page:

image

This page is already linked at the beginning of the Creating your first script documentation page. Users that intend to use C# with Godot should read it.

.. seealso:: To learn more about C#, head to the :ref:`C# basics <doc_c_sharp>` page.

Maybe the note should be reworded so it's a bit more aggresive?


Either way I think adding a note in the step where you add your first script in the Getting Started tutorial makes sense, because I think it's meant to be very hand-holdy.

@raulsntos raulsntos added enhancement topic:dotnet area:getting started Issues and PRs related to the Getting Started section of the documentation labels Jan 9, 2024
@a-johnston
Copy link
Contributor Author

I agree with your comments and honestly I think the current error is pretty clear, but yeah still a common issue I've seen. I think in some cases users get to this page after being linked by Using signals and don't think to follow other links, or don't think they have anything to gain by going over the basics.

@skyace65 skyace65 merged commit f6d53d1 into godotengine:master Jan 10, 2024
1 check passed
@skyace65
Copy link
Contributor

Thanks!

@a-johnston a-johnston deleted the your_first_cs_script branch January 10, 2024 03:10
@a-johnston
Copy link
Contributor Author

Sorry if this isn't the best place to comment (is there an official place to discuss the docs repo?) but I noticed that many docs PRs marked as cherrypicked for a certain version still only show up under latest on the docs pages (for example #8711). This seems like it potentially could be an issue in how the build actions are configured? I'm guessing most users don't bother changing to latest and as a result might be missing out on a lot of corrections/changes.

@Piralein
Copy link
Member

@a-johnston PR's with the cherry-pick label are still to be cherry-picked into the branch the label mentions. This is done by a maintainer, not an deploy/github action. The label will be removed after it was cherry-picked. The linked PR will show up in the stable and 4.2 version of the docs, after it was picked.

mhilbrunner pushed a commit that referenced this pull request Jan 25, 2024
Add c# script name note to scripting_first_script.rst
@mhilbrunner
Copy link
Member

Cherry-picked to 4.2.

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.

5 participants