pygame.music.play() looping docs consistent with pygame and SDL behaviour #1693
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes the pygame docs to correctly describe the existing behaviour of music.play(), which basically mirrors the behaviour of SDLMix_PlayMusic.
In SDL the behaviour of the loops variable is inconsistent between Sounds/Channels and Music and so pygame is too, see the SDL docs for evidence:
SDL Docs:
Mix_PlayMusic: https://www.libsdl.org/projects/SDL_mixer/docs/SDL_mixer.html#SEC57
Mix_PlayChannel: https://www.libsdl.org/projects/SDL_mixer/docs/SDL_mixer.html#SEC28
The docs say they are for Mixer 1.2 but they seem to be using the same docs for SDL 2, and the behaviour is the same.
Downsides:
Upsides: