Skip to content

Commit a149b6f

Browse files
committed
\n may be confusing
1 parent 442c506 commit a149b6f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

adafruit_gps.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ def in_waiting(self):
199199
return self._uart.in_waiting
200200

201201
def readline(self):
202-
"""Returns a \n terminated bytearray, must have timeout set for
202+
"""Returns a newline terminated bytearray, must have timeout set for
203203
the underlying UART or this will block forever!"""
204204
return self._uart.readline()
205205

@@ -467,7 +467,7 @@ def read(self, num_bytes=1):
467467
for _ in range(num_bytes):
468468
with self._i2c as i2c:
469469
# we read one byte at a time, verify it isnt part of a string of
470-
# 'stuffed' \n's and then append to our result array for byteification
470+
# 'stuffed' newlines and then append to our result array for byteification
471471
i2c.readinto(self._charbuff)
472472
char = self._charbuff[0]
473473
if (char == ord('\n')) and (self._lastbyte != ord('\r')):
@@ -489,7 +489,7 @@ def in_waiting(self):
489489
return 32
490490

491491
def readline(self):
492-
"""Returns a \n terminated bytearray, must have timeout set for
492+
"""Returns a newline terminated bytearray, must have timeout set for
493493
the underlying UART or this will block forever!"""
494494
timeout = time.monotonic() + self._timeout
495495
while timeout > time.monotonic():

0 commit comments

Comments
 (0)