Skip to content

Conversation

@microbit-carlos
Copy link
Collaborator

@microbit-carlos microbit-carlos commented Sep 6, 2022

@microbit-carlos microbit-carlos changed the title Update SoundEffect for v2.1 release docs: Update SoundEffect for v2.1 release Sep 6, 2022
: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:
Copy link
Collaborator Author

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

Copy link
Member

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.

Copy link
Collaborator Author

@microbit-carlos microbit-carlos Sep 8, 2022

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_.

Copy link
Member

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.

@microbit-carlos microbit-carlos marked this pull request as draft September 6, 2022 18:10
@microbit-carlos microbit-carlos changed the title docs: Update SoundEffect for v2.1 release docs: Rename SoundEffect wave to waveform Sep 8, 2022
@microbit-carlos microbit-carlos marked this pull request as ready for review September 8, 2022 15:51
@microbit-carlos
Copy link
Collaborator Author

@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 wave->waveform rename, and it's ready to be implemented.

@dpgeorge
Copy link
Member

dpgeorge commented Sep 9, 2022

This change has now been made in the v2 code.

@microbit-carlos
Copy link
Collaborator Author

I'll merge this, as it has been released with the v2.1.0-beta.3.

@microbit-carlos microbit-carlos merged commit cbcd4a9 into bbcmicrobit:v2-docs Sep 21, 2022
@microbit-carlos microbit-carlos deleted the docs-soundeffect branch September 21, 2022 21:44
microbit-carlos added a commit to microbit-carlos/micropython that referenced this pull request Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants