docs: Alphabetise microbit module entries and use docstring notations.

bbcmicrobit / micropython

Port of MicroPython for the BBC micro:bit

https://microbit-micropython.readthedocs.io

Other

595 stars 287 forks source link

docs: Alphabetise microbit module entries and use docstring notations. #734

Closed microbit-carlos closed 2 years ago

microbit-carlos commented 2 years ago

Content hasn't changed and this will help reduce conflicts with upcoming rebase of the v2-docs branch which also needs to do more changes to this file.

microbit-carlos commented 2 years ago

As the docs are slowing adopting the :param :, :returns:, etc docstrings notation I've updated this PR to include those changes for the micro:bit module. I've also added some additional information to be a bit more complete.

microbit-carlos commented 2 years ago

@microbit-mark could you have a quick review once you get a chance? @dpgeorge I assume this kind of updates are generally good to go into the docs without major reviews?

microbit-carlos commented 2 years ago

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

microbit-mark commented 2 years ago

👍🏻 LGTM thanks @microbit-carlos