Skip to content

Commit e95eed5

Browse files
committed
Fix a couple of documentation issues
* Warnings by sphinx (title underline too short) * Example in documentation for the `Sound` class
1 parent 04681c9 commit e95eed5

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ The ev3dev-lang Project on GitHub
198198
would normally need to access this information.
199199

200200
Python 2.x and Python 3.x Compatibility
201-
-------------------------------------
201+
---------------------------------------
202202

203203
Some versions of the ev3dev_ distribution come with both `Python 2.x`_ and `Python 3.x`_ installed
204204
but this library is compatible only with Python 3.

docs/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Frequently-Asked Questions
22
==========================
33

44
My script works when launched as ``python3 script.py`` but exits immediately or throws an error when launched from Brickman or as ``./script.py``
5-
-----
5+
-------------------------------------------------------------------------------------------------------------------------------------------------
66

77
This may occur if your file includes Windows-style line endings, which are often
88
inserted by editors on Windows. To resolve this issue, open an SSH session and

ev3dev/core.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2956,13 +2956,14 @@ class Sound:
29562956
immediately after child process was spawned, without waiting for its
29572957
completion), but you can call wait() on the returned result.
29582958
2959-
Examples:
2959+
Examples::
29602960
29612961
# Play 'bark.wav', return immediately:
29622962
Sound.play('bark.wav')
29632963
29642964
# Introduce yourself, wait for completion:
29652965
Sound.speak('Hello, I am Robot').wait()
2966+
29662967
"""
29672968

29682969
@staticmethod

0 commit comments

Comments
 (0)