search

bbcmicrobit / micropython

Port of MicroPython for the BBC micro:bit
https://microbit-micropython.readthedocs.io
Other
595 stars 287 forks source link

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

Closed microbit-carlos closed 2 years ago

microbit-carlos commented 2 years ago

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 commented 2 years ago

@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 commented 2 years ago

Also backported the tweaks in the "Technical Details" section from the v2-docs branch, commit https://github.com/bbcmicrobit/micropython/commit/38403c07fb3b10781c1df615263fcd69dfb98860#diff-1eb5832ad8abd778154545f6342a1327ba414d6f61c082d12352b56c511757e1R90