8000 Merge pull request #27 from kwagyeman/openmv · WeActStudio/micropython@9c8cc99 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9c8cc99

Browse files
iabdalkaderiabdalkader
authored
Merge pull request micropython#27 from kwagyeman/openmv
Fixed formatting for auto parsing
2 parents 61a6755 + b63a0ab commit 9c8cc99

File tree

6 files changed

+37
-37
lines changed

6 files changed

+37
-37
lines changed

‎docs/library/esp.socket.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,18 @@ UDP Methods
6262
Callback Setter Methods
6363
-----------------------
6464

65-
.. method:: onconnect(lambda)::
65+
.. method:: onconnect(lambda)
6666

6767
When connection is established, call the callback ``lambda``.
6868

69-
.. method:: onrecv(lambda)::
69+
.. method:: onrecv(lambda)
7070

7171
When data is received, call the callback ``lambda``.
7272

73-
.. method:: onsent(lamda)::
73+
.. method:: onsent(lamda)
7474

7575
What data is finished sending, call the callback ``lambda``.
7676

77-
.. method:: ondisconnect(lambda)::
77+
.. method:: ondisconnect(lambda)
7878

7979
Call the callback ``lambda`` when the connection is closed.

‎docs/library/machine.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,16 +110,16 @@ Miscellaneous functions
110110

111111
.. only:: port_openmvcam
112112

113-
.. function:: rng()
113+
.. function:: rng()
114114

115-
Hardware generated random number (int).
115+
Hardware generated random number (int).
116116

117-
.. function:: unique_id()
117+
.. function:: unique_id()
118118

119-
Returns a byte string with a unique identifier of a board/SoC. It will vary
120-
from a board/SoC instance to another, if underlying hardware allows. Length
121-
varies by hardware (so use substring of a full value if you expect a short
122-
ID). In some MicroPython ports, ID corresponds to the network MAC address.
119+
Returns a byte string with a unique identifier of a board/SoC. It will vary
120+
from a board/SoC instance to another, if underlying hardware allows. Length
121+
varies by hardware (so use substring of a full value if you expect a short
122+
ID). In some MicroPython ports, ID corresponds to the network MAC address.
123123

124124
.. only:: port_openmvcam
125125

‎docs/library/omv.fir.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,14 @@ Functions
7575
* None: 0 pixels.
7676
* thermopile shield: 4 pixels.
7777

78-
.. function:: fir.type():
78+
.. function:: fir.type()
7979

8080
Returns the type of the thermopile shield (for future use possibly):
8181

8282
* 0: None
8383
* 1: thermopile shield
8484

85-
.. function:: fir.read_ta():
85+
.. function:: fir.read_ta()
8686

8787
Returns the ambient temperature (i.e. sensor temperature).
8888

@@ -92,7 +92,7 @@ Functions
9292

9393
The value returned is a float that represents the temperature in Celsius.
9494

95-
.. function:: fir.read_ir():
95+
.. function:: fir.read_ir()
9696

9797
Returns a tuple containing the ambient temperature (i.e. sensor temperature),
9898
the temperature list (width * height), the minimum temperature seen, and
@@ -108,7 +108,7 @@ Functions
108108

109109
``ir`` is a (width * height) list of floats.
110110

111-
.. function:: fir.draw_ta(image, ta, alpha=128, scale=[-17.7778, 37.7778]):
111+
.. function:: fir.draw_ta(image, ta, alpha=128, scale=[-17.7778, 37.7778])
112112

113113
Draws the ambient temperature (``ta``) on the ``image`` using a rainbow
114114
table color conversion.
@@ -130,7 +130,7 @@ Functions
130130
``alpha`` and ``scale`` are keyword arguments which must be explicitly
131131
invoked in the function call by writing ``alpha=`` and ``scale=``.
132132

133-
.. function:: fir.draw_ta(image, ir, alpha=128, scale=[auto, auto]):
133+
.. function:: fir.draw_ta(image, ir, alpha=128, scale=[auto, auto])
134134

135135
Draws the temperature list (``ir``) on the ``image`` using a rainbow
136136
table color conversion.

‎docs/library/omv.gif.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,27 +65,27 @@ Constructors
6565
Methods
6666
-------
6767

68-
.. method:: gif.width():
68+
.. method:: gif.width()
6969

7070
Returns the width (horizontal resolution) for the gif object.
7171

72-
.. method:: gif.height():
72+
.. method:: gif.height()
7373

7474
Returns the height (vertical resolution) for the gif object.
7575

76-
.. method:: gif.format():
76+
.. method:: gif.format()
7777

7878
Returns ``sensor.RGB565`` if color or ``sensor.GRAYSCALE`` if not.
7979

80-
.. method:: gif.size():
80+
.. method:: gif.size()
8181

8282
Returns the file size of the gif so far. This value is updated after adding frames.
8383

84-
.. method:: gif.loop():
84+
.. method:: gif.loop()
8585

8686
Returns if the gif object had loop set in its constructor.
8787

88-
.. method:: gif.add_frame(image, delay=10):
88+
.. method:: gif.add_frame(image, delay=10)
8989

9090
Add an image to the gif recording. The image width, height, and color mode,
9191
must be equal to the same width, height, and color modes used in the constructor
@@ -99,7 +99,7 @@ Methods
9999
``delay`` is keyword arguments which must be explicitly invoked in the
100100
function call by writing ``delay=``.
101101

102-
.. method:: gif.close():
102+
.. method:: gif.close()
103103

104104
Finalizes the gif recording. This method must be called once the recording
105105
is complete to make the file viewable.

‎docs/library/omv.lcd.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Example usage::
2424
Functions
2525
---------
2626

27-
.. function:: lcd.init(type=1):
27+
.. function:: lcd.init(type=1)
2828

2929
Initializes an attached lcd shield using I/O pins P0, P2, P3, P6, P7, and P8.
3030

@@ -38,32 +38,32 @@ Functions
3838
``type`` is keyword arguments which must be explicitly invoked in the
3939
function call by writing ``type=``.
4040

41-
.. function:: lcd.deinit():
41+
.. function:: lcd.deinit()
4242

4343
Deinitializes the lcd shield freeing up I/O pins.
4444

45-
.. function:: lcd.width():
45+
.. function:: lcd.width()
4646

4747
Returns the width (horizontal resolution) of the lcd shield.
4848

4949
* None: 0 pixels.
5050
* lcd shield: 128 pixels.
5151

52-
.. function:: lcd.height():
52+
.. function:: lcd.height()
5353

5454
Returns the height (vertical resolution) of the lcd shield.
5555

5656
* None: 0 pixels.
5757
* lcd shield: 160 pixels.
5858

59-
.. function:: lcd.type():
59+
.. function:: lcd.type()
6060

6161
Returns the type of the lcd shield (for future use possibly):
6262

6363
* 0: None
6464
* 1: lcd Shield
6565

66-
.. function:: lcd.set_backlight(state):
66+
.. function:: lcd.set_backlight(state)
6767

6868
Set the lcd shield backlight state (False for off - True for on). Turning
6969
off the backlight dramatically reduces the lcd shield's current consumption.
@@ -76,12 +76,12 @@ Functions
7676
backlight jumper on the lcd shield (leaving the backlight permanently on).
7777
This frees up P6 as long as you do not call this function.
7878

79-
.. function:: lcd.get_backlight():
79+
.. function:: lcd.get_backlight()
8080

8181
Returns the backlight state (False for off - True for on) if
8282
``set_backlight`` had been called previously.
8383

84-
.. function:: lcd.display(image, roi=Auto):
84+
.. function:: lcd.display(image, roi=Auto)
8585

8686
Displays an ``image`` (GRAYSCALE or RGB565) on the lcd screen.
8787

@@ -109,6 +109,6 @@ Functions
109109
``roi`` is keyword arguments which must be explicitly invoked in the
110110
function call by writing ``roi=``.
111111

112-
.. function:: lcd.clear():
112+
.. function:: lcd.clear()
113113

114114
Clears the lcd screen to black.

‎docs/library/omv.mjpeg.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,19 @@ Constructors
5757
Methods
5858
-------
5959

60-
.. method:: mjpeg.width():
60+
.. method:: mjpeg.width()
6161

6262
Returns the width (horizontal resolution) for the mjpeg object.
6363

64-
.. method:: mjpeg.height():
64+
.. method:: mjpeg.height()
6565

6666
Returns the height (vertical resolution) for the mjpeg object.
6767

68-
.. method:: mjpeg.size():
68+
.. method:: mjpeg.size()
6969

7070
Returns the file size of the mjpeg so far. This value is updated after adding frames.
7171

72-
.. method:: mjpeg.add_frame(image, quality=50):
72+
.. method:: mjpeg.add_frame(image, quality=50)
7373

7474
Add an image to the mjpeg recording. The image width, height, and color mode,
7575
must be equal to the same width, height, and color modes used in the constructor
@@ -83,7 +83,7 @@ Methods
8383
``quality`` is keyword arguments which must be explicitly invoked in the
8484
function call by writing ``quality=``.
8585

86-
.. method:: mjpeg.close(fps):
86+
.. method:: mjpeg.close(fps)
8787

8888
Finalizes the mjpeg recording. This method must be called once the recording
8989
is complete to make the file viewable.

0 commit comments

Comments
 (0)
0