Skip to content

Commit 13fc2f6

Browse files
author
brentru
committed
put back returns function comments
1 parent 3fa3b2b commit 13fc2f6

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

adafruit_fona/adafruit_fona.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ def send_sms(self, phone_number, message):
497497
return True
498498

499499
def num_sms(self, sim_storage=True):
500-
"""Number of SMS messages stored in memory.
500+
"""Returns the number of SMS messages stored in memory.
501501
:param bool sim_storage: SMS storage on the SIM, otherwise internal storage on FONA chip.
502502
503503
"""
@@ -636,7 +636,7 @@ def get_socket(self):
636636
return allocated_socket
637637

638638
def remote_ip(self, sock_num):
639-
"""IP address of the remote server.
639+
"""Returns the IP address of the remote server.
640640
:param int sock_num: Desired socket.
641641
642642
"""
@@ -651,7 +651,7 @@ def remote_ip(self, sock_num):
651651
return self._buf
652652

653653
def socket_status(self, sock_num):
654-
"""Socket connection status, False if not connected to remote server.
654+
"""Returns the socket connection status, False if not connected.
655655
:param int sock_num: Desired socket number.
656656
657657
"""
@@ -681,7 +681,7 @@ def socket_status(self, sock_num):
681681
return True
682682

683683
def socket_available(self, sock_num):
684-
"""Amount of bytes available to be read from the socket.
684+
"""Returns the amount of bytes available to be read from the socket.
685685
:param int sock_num: Desired socket to return bytes available from.
686686
687687
"""

adafruit_fona/fona_3g.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ def get_host_by_name(self, hostname):
193193
return self._buf
194194

195195
def get_socket(self):
196-
"""Obtains an unused socket."""
196+
"""Returns an unused socket."""
197197
if self._debug:
198198
print("*** Get socket")
199199

@@ -254,7 +254,8 @@ def socket_connect(self, sock_num, dest, port, conn_mode=0):
254254
return True
255255

256256
def remote_ip(self, sock_num):
257-
"""IP address of remote connection."""
257+
"""Returns the IP address of the remote connection.
258+
"""
258259
self._read_line()
259260
assert (
260261
sock_num < FONA_MAX_SOCKETS
@@ -313,7 +314,7 @@ def socket_write(self, sock_num, buffer, timeout=120000):
313314
return True
314315

315316
def socket_status(self, sock_num):
316-
"""Socket status, True if connected. False otherwise.
317+
"""Returns socket status, True if connected. False otherwise.
317318
:param int sock_num: Desired socket number.
318319
319320
"""

0 commit comments

Comments
 (0)