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.

Sign up for GitHub

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

Jump to bottom

Snake-case .tscn, .gd and _on_* callbacks #6598

Closed
wants to merge 7 commits into from
Closed

Snake-case .tscn, .gd and _on_* callbacks #6598

wants to merge 7 commits into from

Conversation

snoopdouglas
Copy link
Contributor

@snoopdouglas snoopdouglas commented Jan 12, 2023 •
edited
Loading

As per the disparities noted in #6245, this PR snake-cases all .tscn and .gd filenames, and _on_* callbacks, throughout the documentation.

Some of the filenames referenced are in example projects, so these need to be updated too.

I noticed quite a bit of trailing whitespace being removed as I went through and saved things. I'm inexperienced with RST, so if the whitespace is semantic, let me know and I'll revert those lines.

@snoopdouglas snoopdouglas changed the title Snake-case .tscn, .gd and _on_* callbacks Snake-case .tscn, .gd, .cs and _on_* callbacks Jan 12, 2023
@Calinou
Copy link
Member

Calinou commented Jan 12, 2023 •
edited
Loading

and .cs filenames

.cs file names must match the class name (this is a C# language requirement), so they must keep using PascalCase. GDScript files should use snake_case by convention still.

@snoopdouglas
Copy link
Contributor Author

@Calinou No worries, should be sorted now!

@snoopdouglas snoopdouglas changed the title Snake-case .tscn, .gd, .cs and _on_* callbacks Snake-case .tscn, .gd and _on_* callbacks Jan 12, 2023
@skyace65
Copy link
Contributor

The class reference changes need to be removed from this PR. Changes to the class reference need to be made in the main Godot repository, not the docs. The pages in the docs repository are generated from what's in the main repository. You can find those pages here.

@skyace65 skyace65 added area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jan 13, 2023
@snoopdouglas snoopdouglas mentioned this pull request Jan 15, 2023
Merged
@snoopdouglas
Copy link
Contributor Author

@skyace65 Sorry about that, all sorted now. Changes to the class reference in this PR have been reverted. godotengine/godot#71461

@skyace65
Copy link
Contributor

This PR needs to be rebased.

@skyace65 skyace65 added the needs work Needs additional work by the original author, someone else or in another repo. label Jan 29, 2023
@snoopdouglas
Copy link
Contributor Author

@skyace65 Rebase complete, this looks mergeable now.

raulsntos
raulsntos requested changes Jan 29, 2023
View reviewed changes
tutorials/best_practices/scenes_versus_scripts.rst Outdated Show resolved Hide resolved
tutorials/physics/using_character_body_2d.rst Outdated Show resolved Hide resolved
getting_started/step_by_step/scripting_player_input.rst Outdated Show resolved Hide resolved
raulsntos
raulsntos reviewed Jan 31, 2023
View reviewed changes
tutorials/scripting/nodes_and_scene_instances.rst Outdated Show resolved Hide resolved
tutorials/scripting/singletons_autoload.rst Outdated Show resolved Hide resolved
tutorials/scripting/singletons_autoload.rst Outdated Show resolved Hide resolved
raulsntos
raulsntos approved these changes Feb 1, 2023
View reviewed changes
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, should probably be reviewed by someone on GDScript's side as well.

@mhilbrunner mhilbrunner mentioned this pull request Mar 23, 2023
Closed
This was referenced Apr 16, 2023
Closed
Closed
@Vennnot
Copy link
Contributor

Vennnot commented Apr 26, 2023

This can be merged, no?

mhilbrunner added a commit to mhilbrunner/godot-docs that referenced this pull request May 18, 2023
@mhilbrunner @snoopdouglas
Snake-case .tscn, .gd and _on_* callbacks
a712155 
Salvaging the previous work in godotengine#6598.

Co-authored-by: Doug Thompson <s-git@dougthompson.co.uk>
@mhilbrunner mhilbrunner mentioned this pull request May 18, 2023
Merged
@mhilbrunner
Copy link
Member

Rebased onto master in #7370, I re-added all changes that were not yet done by other PRs, giving you credit in the commit. Thanks for contributing!

@mhilbrunner mhilbrunner added archived and removed enhancement needs work Needs additional work by the original author, someone else or in another repo. area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@raulsntos raulsntos raulsntos approved these changes

Assignees
No one assigned
Labels
archived
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@snoopdouglas @Calinou @skyace65 @Vennnot @mhilbrunner @raulsntos