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# example for the AudioStreamGenerator code snippet #84648

Merged
merged 1 commit into from
Nov 10, 2023

Conversation

NiftyHat
Copy link
Contributor

@NiftyHat NiftyHat commented Nov 9, 2023

Added a C# example for the AudioStreamGenerator code snippet.

@NiftyHat NiftyHat requested a review from a team as a code owner November 9, 2023 05:34
doc/classes/AudioStreamGenerator.xml Outdated Show resolved Hide resolved
doc/classes/AudioStreamGenerator.xml Outdated Show resolved Hide resolved
doc/classes/AudioStreamGenerator.xml Outdated Show resolved Hide resolved
doc/classes/AudioStreamGenerator.xml Outdated Show resolved Hide resolved
doc/classes/AudioStreamGenerator.xml Outdated Show resolved Hide resolved
@akien-mga akien-mga changed the title Update AudioStreamGenerator.xml Add C# example for the AudioStreamGenerator code snippet Nov 9, 2023
@akien-mga akien-mga added this to the 4.x milestone Nov 9, 2023
@akien-mga akien-mga requested a review from a team November 9, 2023 09:52
@akien-mga
Copy link
Member

Thanks for the contribution!

I pointed out some code style issues in the example which should be solved. The best way to do it is by amending the commit so that it stays as a single commit in this PR, which is the way we'd want to merge such a documentation improvement.
See PR workflow for instructions.

While at it, please also update the commit message to be more explicit (e.g. reusing what I put as PR title). "Update file" doesn't say what the update does so it's not a good informative commit message.

@NiftyHat
Copy link
Contributor Author

I've made the changes but I think something went wrong the the amendment and now there are two commits instead of one. I did try to squash them but git wouldn't let me due to the commits having multiple parents :(

@akien-mga
Copy link
Member

I squashed the commits for you, it wasn't trivial indeed after the latest changes, not sure how the Git history ended up exactly.

I also fixed a few formatting issues (trailing whitespace, [codeblocks] should be plural when using the language-specific subblocks, and < needs to be escaped as &lt; in XML).

@akien-mga akien-mga merged commit 804c192 into godotengine:master Nov 10, 2023
15 checks passed
@akien-mga
Copy link
Member

Thanks! And congrats for your first merged Godot contribution 🎉

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.

None yet

2 participants