Skip to content

Conversation

@dhalbert
Copy link
Collaborator

@dhalbert dhalbert commented Mar 7, 2021

Fixes #4345.
Fixes #4352.

These are documentation changes only.

@dhalbert dhalbert requested a review from jepler March 7, 2021 18:51
@dhalbert dhalbert force-pushed the usb_cdc-connect-doc-note branch from adf9233 to 8594396 Compare March 7, 2021 19:07
@dhalbert dhalbert changed the title Add caveat for usb_cdc.Serial.connected Add caveat for usb_cdc.Serial.connected; fix another doc bug Mar 7, 2021
@ismael-miguel
Copy link

Loosely related to issue #4345:

The usb_cdc documentation (https://circuitpython.readthedocs.io/en/latest/shared-bindings/usb_cdc/index.html) is missing the following methods :

  • readline() - returns bytearray, takes 0 or 1 argument, seems to be a _typing.WriteableBuffer) or some sort of stream
  • readlines() - returns array of bytearray

Aditionally, it is missing any information about how to change the newline character, if possible at all.

@dhalbert dhalbert marked this pull request as draft March 7, 2021 20:09
@dhalbert dhalbert marked this pull request as ready for review March 7, 2021 20:34
jepler
jepler previously approved these changes Mar 7, 2021
@jepler
Copy link

jepler commented Mar 7, 2021

@dhalbert I think this is good to go but I'm leaving un-merged in case you want to make any change related to @ismael-miguel's review comment (and the build's not finished anyway)

@dhalbert dhalbert force-pushed the usb_cdc-connect-doc-note branch from 1c3a274 to a147e74 Compare March 8, 2021 01:20
@dhalbert dhalbert force-pushed the usb_cdc-connect-doc-note branch from a147e74 to 24ac815 Compare March 8, 2021 01:33
@dhalbert dhalbert requested a review from tannewt March 8, 2021 20:53
@dhalbert
Copy link
Collaborator Author

dhalbert commented Mar 8, 2021

Anybody can review and merge.

Copy link

@jepler jepler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@jepler jepler merged commit 240909e into adafruit:main Mar 8, 2021
@dhalbert dhalbert deleted the usb_cdc-connect-doc-note branch October 13, 2021 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants