8000 docs: Backport last V2 changes to V1 docs. (#748) · bbcmicrobit/micropython@fe0e8dd · GitHub
[go: up one dir, main page]

Skip to content

Commit fe0e8dd

Browse files
docs: Backport last V2 changes to V1 docs. (#748)
The main change is removing the Installation page, as I forgot to remove the file in PR #745 Took the opportunity to add a few very minor formatting changes from the v2-docs branch, which wil reduce the diff with the main branch.
1 parent a41ec63 commit fe0e8dd

File tree

4 files changed

+15
-128
lines changed

4 files changed

+15
-128
lines changed

docs/devguide/installation.rst

Lines changed: 0 additions & 118 deletions
This file was deleted.

docs/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ BBC micro:bit MicroPython documentation
88

99
Welcome!
1010

11-
The BBC micro:bit is a small computing device for children. One of the
12-
languages it understands is the popular Python programming language. The
13-
version of Python that runs on the BBC micro:bit is called MicroPython.
11+
The `BBC micro:bit <https://microbit.org>`_ is a small computing device for
12+
children. One of the languages it understands is the popular Python programming
13+
language. The version of Python that runs on the BBC micro:bit is called
14+
MicroPython.
1415

1516
This documentation includes lessons for teachers
1617
and API documentation for developers (check out the index on the left). We hope

docs/microbit_micropython_api.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,12 @@ The LED display is exposed via the `display` object::
7373
Pins
7474
----
7575

76-
Provide digital and analog input and output functionality, for the pins in the connector. Some pins are connected internally to the I/O that drives the LED matrix and the buttons.
76+
Provide digital and analog input and output functionality, for the pins in the
77+
connector. Some pins are connected
78+
internally to the I/O that drives the LED matrix and the buttons.
7779

78-
Each pin is provided as an object directly in the ``microbit`` module. This keeps the API relatively flat, making it very easy to use:
80+
Each pin is provided as an object directly in the ``microbit`` module. This
81+
keeps the API relatively flat, making it very easy to use:
7982

8083
* pin0
8184
* pin1
@@ -102,7 +105,8 @@ Each of these pins are instances of the ``MicroBitPin`` class, which offers the
102105
# sets the period of the PWM output of the pin in microseconds
103106
# (see https://en.wikipedia.org/wiki/Pulse-width_modulation)
104107
pin.set_analog_period_microseconds(int)
105-
# returns boolean
108+
# Only available for touch pins 0, 1, and 2. Returns boolean if the pin
109+
# is touched
106110
pin.is_touched()
107111

108112
Images

docs/music.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ Functions
109109

110110
If ``wait`` is set to ``True``, this function is blocking.
111111

112-
If ``duration`` is negative the pitch is played continuously until either the
113-
blocking call is interrupted or, in the case of a background call, a new
114-
frequency is set or ``stop`` is called (see below).
112+
If ``duration`` is negative the pitch is played continuously until either
113+
the blocking call is interrupted or, in the case of a background call, a
114+
new frequency is set or ``stop`` is called (see below).
115115

116116
.. py:function:: stop(pin=pin0)
117-
117+
118118
Stops all music playback on a given pin, eg. ``music.stop(pin1)``.
119119
If no pin is given, eg. ``music.stop()`` pin0 is assumed.
120120

0 commit comments

Comments
 (0)
0