Final edit.

Author: BiffoBear

adafruit_wiznet5k/adafruit_wiznet5k.py

@@ -289,15 +289,16 @@ def chip(self) -> str:
         """
         Ethernet controller chip type.
 
-        :return str: The chip type."""
+        :return str: The chip type.
+        """
         return self._chip_type
 
     @property
     def ip_address(self) -> bytearray:
         """
         Configured IP address.
 
-        :return bytearray.
+        :return bytearray: IP address as four bytes.
         """
         return self.read(REG_SIPR, 0x00, 4)
 
@@ -307,7 +308,7 @@ def pretty_ip(
         ip: bytearray,
     ) -> str:
         """
-        Convert a bytearray IP address to a dotted-quad string for printing.
+        Convert a 4 byte IP address to a dotted-quad string for printing.
 
         :param bytearray ip: A four byte IP address.
 
@@ -323,9 +324,9 @@ def unpretty_ip(
         """
         Convert a dotted-quad string to a four byte IP address.
 
-        :param str ip: The IP address (a string of the form '255.255.255.255') to be converted.
+        :param str ip: IP address (a string of the form '255.255.255.255') to be converted.
 
-        :return bytes: The IP address in four bytes.
+        :return bytes: IP address in four bytes.
         """
         octets = [int(x) for x in ip.split(".")]
         return bytes(octets)
@@ -335,7 +336,7 @@ def mac_address(self) -> bytearray:
         """
         Ethernet hardware's MAC address.
 
-        :return bytearray: The six byte MAC address."""
+        :return bytearray: Six byte MAC address."""
         return self.read(REG_SHAR, 0x00, 6)
 
     @mac_address.setter
@@ -374,7 +375,7 @@ def remote_ip(self, socket_num: int) -> Union[str, bytearray]:
 
         :param int socket_num: ID number of the socket to check.
 
-        :return Union[str, bytearray]: The four byte IP address.
+        :return Union[str, bytearray]: A four byte IP address.
         """
         if socket_num >= self.max_sockets:
             return self._pbuff
@@ -553,7 +554,7 @@ def read(
         :param int length: Number of bytes to read from the register, defaults to 1.
         :param Optional[WriteableBuffer] buffer: Buffer to read data into, defaults to None.
 
-        :return Union[WriteableBuffer, bytearray]: The data read from the chip.
+        :return Union[WriteableBuffer, bytearray]: Data read from the chip.
         """
         with self._device as bus_device:
             if self._chip_type == "w5500":
@@ -609,6 +610,7 @@ def socket_available(self, socket_num: int, sock_type: int = SNMR_TCP) -> int:
         :param int socket_num: Socket to check for available bytes.
         :param int sock_type: Socket type. Use SNMR_TCP for TCP or SNMR_UDP for UDP, \
             defaults to SNMR_TCP.
+
         :return int: Number of bytes available to read.
         """
         if self._debug:

adafruit_wiznet5k/adafruit_wiznet5k_socket.py

@@ -539,8 +539,8 @@ def readline(self) -> bytes:
         """
         Read a line from the socket.
 
-        Attempt to return as many bytes as we can up to but not including carriage return and
-        linefeed charater pairs.
+        Attempt to return as many bytes as we can up to but not including a carriage return and
+        linefeed charater pair.
 
         :return bytes: The data read from the socket.
         """

adafruit_wiznet5k/adafruit_wiznet5k_wsgiserver.py

@@ -180,7 +180,7 @@ def _get_environ(self, client: socket.socket) -> Dict:
         The application callable will be given the resulting environ dictionary.
         It contains metadata about the incoming request and the request body ("wsgi.input")
 
-        :param socket.socket client: socket to read the request from.
+        :param socket.socket client: Socket to read the request from.
 
         :return Dict: Data for the application callable.
         """