Skip to content

Commit bb9837f

Browse files
committed
docstring
1 parent 86d161e commit bb9837f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

adafruit_esp32spi/adafruit_esp32spi_socketpool.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,13 @@ def socket( # pylint: disable=redefined-builtin
7676

7777
class Socket:
7878
"""A simplified implementation of the Python 'socket' class, for connecting
79-
through an interface to a remote device"""
79+
through an interface to a remote device. Has properties specific to the
80+
implementation.
81+
82+
:param SocketPool socket_pool: The underlying socket pool.
83+
:param Optional[int] socknum: Allows wrapping a Socket instance around a socket
84+
number returned by the nina firmware. Used internally.
85+
"""
8086

8187
def __init__( # pylint: disable=redefined-builtin,too-many-arguments,unused-argument
8288
self,

0 commit comments

Comments
 (0)