Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

doc/builtins/Speaker: use '' for string settings

Browse Source 
Also simplify by not listing all the options twice, and follow style for default argument.
This commit is contained in:
Laurens Valk
2020-01-27 13:12:57 +01:00
parent aac25bb050
commit 167cf3ad18
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pybricks/builtins.py
+4 -5
View File
@@ -421,11 +421,10 @@ class Speaker():
volume (:ref:`percentage`):
Volume of the speaker.
which (str):
The specific volume to set. Can be ``Beep``, ``PCM`` or
``_all_``. ``Beep`` controls the volume for :meth:`beep` and
:meth:`play_notes`. ``PCM`` controls the volume for
:meth:`play_file` and :meth:`say`. ``_all_`` sets both at the
same time.
Which volume to set. ``'Beep'`` sets the volume for
:meth:`beep` and :meth:`play_notes`. ``'PCM'`` sets the volume
for :meth:`play_file` and :meth:`say`. ``'_all_'`` sets both
at the same time (*Default*: ``'_all_'``).
"""
pass