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

docs: Audio can be accessed from microbit module & add docstring notation. #740

Merged
merged 2 commits into from
Apr 25, 2022

Conversation

microbit-carlos
Copy link
Collaborator

@microbit-carlos microbit-carlos commented Apr 21, 2022

The audio module now is also available via microbit.audio in V1 as it is in V2.

The PR also updates the content to use docstring notation like :param xxx:.

It also adds documentation for AudioFrame.copyfrom(), which wasn't covered before.

Review URL: https://microbit-micropython--740.org.readthedocs.build/en/740/audio.html

@microbit-carlos
Copy link
Collaborator Author

@microbit-mark could you review once you get a chance?

I'll have to rebase v2-docs again after merging this and will make sure the V2 content is properly merged with this conflicting changes.

Thanks!

@microbit-carlos microbit-carlos changed the title docs: Add do docstring notation to audio & add it's also in microbit module. docs: Add docstring notation to audio and that it's also in the microbit module. Apr 21, 2022
docs/audio.rst Outdated Show resolved Hide resolved
Also adds docs for AudioFrame.copyfrom().

And backports the tweaks in the Technical Details section from
the V2 docs commit
bbcmicrobit@38403c0#diff-1eb5832ad8abd778154545f6342a1327ba414d6f61c082d12352b56c511757e1R90
@microbit-carlos
Copy link
Collaborator Author

Also backported the tweaks in the "Technical Details" section from the v2-docs branch, commit 38403c0#diff-1eb5832ad8abd778154545f6342a1327ba414d6f61c082d12352b56c511757e1R90

@microbit-carlos microbit-carlos changed the title docs: Add docstring notation to audio and that it's also in the microbit module. docs: Audio can be accessed from microbit module & add docstring notation. Apr 22, 2022
@microbit-carlos microbit-carlos merged commit dc4d06c into bbcmicrobit:master Apr 25, 2022
@microbit-carlos microbit-carlos deleted the docs-audio branch April 25, 2022 15:20
@microbit-carlos microbit-carlos added this to the Version 1.1 milestone Aug 31, 2022
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