Skip to content

Commit 63ca6de

Browse files
docs: Fix argument names for display show() and scroll(). (bbcmicrobit#738)
1 parent 072c5a1 commit 63ca6de

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/display.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Functions
3232
Display the ``image``.
3333

3434

35-
.. py:function:: show(value, delay=400, \*, wait=True, loop=False, clear=False)
35+
.. py:function:: show(image, delay=400, \*, wait=True, loop=False, clear=False)
3636
37-
If ``value`` is a string, float or integer, display letters/digits in sequence.
38-
Otherwise, if ``value`` is an iterable sequence of images, display these images in sequence.
37+
If ``image`` is a string, float or integer, display letters/digits in sequence.
38+
Otherwise, if ``image`` is an iterable sequence of images, display these images in sequence.
3939
Each letter, digit or image is shown with ``delay`` milliseconds between them.
4040

4141
If ``wait`` is ``True``, this function will block until the animation is
@@ -54,9 +54,9 @@ Functions
5454
in the generator as allocating memory in an interrupt is prohibited and will raise a
5555
``MemoryError``.
5656

57-
.. py:function:: scroll(value, delay=150, \*, wait=True, loop=False, monospace=False)
57+
.. py:function:: scroll(text, delay=150, \*, wait=True, loop=False, monospace=False)
5858
59-
Scrolls ``value`` horizontally on the display. If ``value`` is an integer or float it is
59+
Scrolls ``text`` horizontally on the display. If ``text`` is an integer or float it is
6060
first converted to a string using ``str()``. The ``delay`` parameter controls how fast
6161
the text is scrolling.
6262

0 commit comments

Comments
 (0)