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

Change "sample" to "stream" in AudioStreamWAV documentation #93499

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

Meorge
Copy link
Contributor

@Meorge Meorge commented Jun 23, 2024

Previously, AudioStreamWAV.loop_begin had this as its description:

The loop start point (in number of samples, relative to the beginning of the sample).

and likewise for AudioStreamWAV.loop_end.

Unless I'm misunderstanding what this is trying to say, I believe the word "stream" is a better fit. While some may think that "sample" can refer to the audio being stored in the stream, it has a well-defined meaning as a single point of data:

A sample is a value of the [sound] signal at a point in time and/or space; this definition differs from the term's usage in statistics, which refers to a set of such values.

The existing documentation uses the term "sample" correctly earlier in the sentence. Replacing the second instance of the word with "stream" makes it more clear what the variable means.

@Meorge Meorge requested a review from a team as a code owner June 23, 2024 03:08
@Mickeon Mickeon added this to the 4.3 milestone Jun 23, 2024
Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

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

It's the small things that count.

@Mickeon Mickeon added cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Jun 23, 2024
@akien-mga akien-mga merged commit c466010 into godotengine:master Jun 25, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

@Meorge Meorge deleted the fix_audiostreamwav_docs branch December 1, 2024 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants