Skip to content

Commit 5c0b8ed

Browse files
authored
Combine docs
Don't mention switch methods which are implementation details.
1 parent 2d969ba commit 5c0b8ed

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

simpleio.py

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -228,14 +228,13 @@ def deinit(self):
228228

229229
class DigitalOut:
230230
"""
231-
Simple digital output that is valid until soft reset.
231+
Simple digital output that is valid until reload.
232+
233+
:param pin microcontroller.Pin: output pin
234+
:param value bool: default value
235+
:param drive_mode digitalio.DriveMode: drive mode for the output
232236
"""
233237
def __init__(self, pin, **kwargs):
234-
"""
235-
kwargs will be passed directly to switch_to_output
236-
value (bool): default value to set upon switching
237-
drive_mode (DriveMode): drive mode for the output
238-
"""
239238
self.iopin = digitalio.DigitalInOut(pin)
240239
self.iopin.switch_to_output(**kwargs)
241240

@@ -250,13 +249,12 @@ def value(self, value):
250249

251250
class DigitalIn:
252251
"""
253-
Simple digital input that is valid until soft reset.
252+
Simple digital input that is valid until reload.
253+
254+
:param pin microcontroller.Pin: input pin
255+
:param pull digitalio.Pull: pull configuration for the input
254256
"""
255257
def __init__(self, pin, **kwargs):
256-
"""
257-
kwargs will be passed directly to switch_to_input
258-
pull (pull): pull configuration for the input
259-
"""
260258
self.iopin = digitalio.DigitalInOut(pin)
261259
self.iopin.switch_to_input(**kwargs)
262260

0 commit comments

Comments
 (0)