Skip to content

Commit 4bc7096

Browse files
Update documentation
1 parent b3b5aac commit 4bc7096

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# micro:bit MicroPython stubs for editor support
22

3+
The easiest way to try these type stubs is to use the online [micro:bit Python Editor](https://python.microbit.org) which bundles them.
4+
35
## Translations
46

5-
We maintain translations of these files via Crowdin.
7+
We maintain translations of these files in the [micro:bit Crowdin project](https://crowdin.com/project/microbitorg) in [this file](https://crowdin.com/translate/microbitorg/6422). Only changes to the English source should be made in this repository.
68

79
The source content is in English in `lang/en`.
810

@@ -12,12 +14,12 @@ We translate:
1214

1315
- First lines of all docstrings
1416
- First lines of parameter documentation in `:param name:`-style
15-
- The API name, e.g. function name, with underscores replaced with spaces to make clear it's a hint not the actual name
16-
- Parameter names (again with underscores replaced)
17+
- The API name, e.g. function name, with underscores replaced with spaces to make clear it's a hint not the actual name. This is displayed alongside the English API name.
18+
- Parameter names (again with underscores replaced). These are displayed alongside the English parameter name.
1719

1820
## Credit and licensing
1921

20-
builtins and utility definitions are derived from [typeshed](https://github.com/python/typeshed). Further work is required to review these to ensure that we don't have stubs for definitions MicroPython does not support. These stubs don't provide documentation.
22+
builtins and utility definitions are derived from [typeshed](https://github.com/python/typeshed). These stubs don't provide documentation, though we'd love to add it in future.
2123

2224
MicroPython and micro:bit stubs are based on the restructured text documentation for [micro:bit](https://github.com/bbcmicrobit/micropython/tree/v2-docs) and, where not otherwise covered in micro:bit-specific docs, [MicroPython](https://github.com/micropython/micropython/tree/master/docs/library). These stubs provide documentation.
2325

0 commit comments

Comments
 (0)