Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add caveat for usb_cdc.Serial.connected; fix another doc bug #4359

Merged
merged 5 commits into from
Mar 8, 2021

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 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
Member

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
Copy link
Collaborator Author

dhalbert commented Mar 8, 2021

Anybody can review and merge.

Copy link
Member

@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