cute_sound.h: errors in documentation

RandyGaul / cute_headers

Collection of cross-platform one-file C/C++ libraries with no dependencies, primarily used for games

4.3k stars 270 forks source link

cute_sound.h: errors in documentation #215

Closed andykt closed 4 years ago

andykt commented 4 years ago

Noticed a few errors in the cute_sound.h comments:

replace "platforms SDL2" with "platforms where SDL2"
replace "apart" with "a part" (occurs twice)
the High-level API comments mention "cs_play_def" a few times but that no longer exists
the cs_mix comments mention "num_samples_to_write" but that no longer exists
there's a printf("Entering mix...\n") call that should probably be removed

RandyGaul commented 4 years ago

Great, make a pull request to fix it!

andykt commented 4 years ago

Sorry, but making pull requests is a pain in the butt. Any chance you can give me commit permissions to the master repo? Send me an email and I can give you more details about my bona fides. I don't use twitter or discord.

BTW, I noticed what looks like a bug in cute_sound.h. I needed to add "sound->loaded_sound = 0;" to cs_stop_all_sounds to avoid cs_mix crashing my Mac app (I'm using the high-level API with cs_spawn_mix_thread).

RandyGaul commented 4 years ago

You can do this all from the github website. Click the fork button.

Then in your fork, edit the files right there by clicking the edit button.

Then there's even a "commit and create pull request" green button that will appear.

Once the pull request is merged, just delete your fork.

RandyGaul commented 4 years ago

I just did this all in another repo, so I've verified it's all working and super easy to do -- https://github.com/floooh/sokol/pull/355

Also you can continue making more commits the same way, and your pull request is automatically update with those commits.