-
Notifications
You must be signed in to change notification settings - Fork 287
docs: Rename SoundEffect wave to waveform #765
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
docs: Rename SoundEffect wave to waveform #765
Conversation
| :param vol_end: End volume value, range 0-255, default: ``0`` | ||
| :param wave: Type of wave shape, one of these values: ``WAVE_SINE``, | ||
| ``WAVE_SAWTOOTH``, ``WAVE_TRIANGLE``, ``WAVE_SQUARE``, | ||
| :param waveform: Type of waveform shape, one of these values: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A suggestion by @microbit-giles
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest we then also change the constants to WAVEFORM_SAWTOOTH etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was a bit hesitant to make these constants even longer, but it makes sense to keep the same name, so I've updated the PR for the constants to start with WAVEFORM_.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think consistency is important here.
d7f0227 to
b8c461c
Compare
|
@dpgeorge I've separated the predefined sounds out of this PR into a new one, as we won't have time to implement these before the v2.1.0 release: This PR now only contains the |
b8c461c to
a569258
Compare
|
This change has now been made in the v2 code. |
|
I'll merge this, as it has been released with the v2.1.0-beta.3. |
https://microbit-micropython--765.org.readthedocs.build/en/765/audio.html