Skip to content

Commit b316686

Browse files
author
brentru
committed
documentation fix, linting
1 parent 31ebc32 commit b316686

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ For information on building library documentation, please check out `this guide
117117
License
118118
=============
119119

120-
This library was written by `Arduino LLC<https://github.com/arduino-libraries/Ethernet/blob/master/AUTHORS>`_. We've converted it to work
121-
with `CircuitPython<https://circuitpython.org/>`_ and made changes so it works similarly to `CircuitPython's WIZNET5k wrapper for the WIZnet
122-
5500 Ethernet interface<https://circuitpython.readthedocs.io/en/latest/shared-bindings/wiznet/wiznet5k.html>`_ and CPython's `Socket low-level
123-
networking interface module<https://docs.python.org/3.8/library/socket.html>`_.
120+
This library was written by `Arduino LLC <https://github.com/arduino-libraries/Ethernet/blob/master/AUTHORS>`_. We've converted it to work
121+
with `CircuitPython <https://circuitpython.org/>`_ and made changes so it works similarly to `CircuitPython's WIZNET5k wrapper for the WIZnet
122+
5500 Ethernet interface <https://circuitpython.readthedocs.io/en/latest/shared-bindings/wiznet/wiznet5k.html>`_ and CPython's `Socket low-level
123+
networking interface module <https://docs.python.org/3.8/library/socket.html>`_.
124124

125125
This open source code is licensed under the LGPL license (see LICENSE for details).

adafruit_wiznet5k/adafruit_wiznet5k_dhcp.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ def __init__(self, eth, mac_address, timeout=1, timeout_response=1):
120120
def send_dhcp_message(self, state, time_elapsed):
121121
"""Assemble and send a DHCP message packet to a socket.
122122
:param int state: DHCP Message state.
123-
:param float time_elapsed: Number of seconds elapsed since client
124-
attempted to acquire/renew a lease.
123+
:param float time_elapsed: Number of seconds elapsed since client attempted to acquire/renew a lease.
124+
125125
"""
126126
# OP
127127
_BUFF[0] = DHCP_BOOT_REQUEST

adafruit_wiznet5k/adafruit_wiznet5k_socket.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ def recv(self, bufsize=0): #pylint: disable=too-many-branches
193193

194194
def readline(self):
195195
"""Attempt to return as many bytes as we can up to
196-
but not including '\n'"""
196+
but not including \n"""
197197
stamp = time.monotonic()
198198
while b'\n' not in self._buffer:
199199
if self._sock_type == SOCK_STREAM:

docs/api.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,11 @@
44
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
55
.. use this format as the module name: "adafruit_foo.foo"
66
7-
.. automodule:: adafruit_wiznet5k
7+
.. automodule:: adafruit_wiznet5k.adafruit_wiznet5k
88
:members:
9+
10+
.. automodule:: adafruit_wiznet5k.adafruit_wiznet5k_socket
11+
:members:
12+
13+
.. automodule:: adafruit_wiznet5k.adafruit_wiznet5k_dhcp
14+
:members:

0 commit comments

Comments
 (0)