Skip to content

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Jan 23, 2019

The Serial reference pages contained large amounts of incorrect or extremely outdated information about which serial ports were available for each board.

  • Add a table to the Serial reference homepage which lists the available ports for each board. Previously, this was done in a verbose manner that does not lend itself to the ever increasing information that must be conveyed on this topic as new boards are added.
  • Rather than document syntax for each of the list of possible serial objects, only document each function signature and then point the reader to the list of available ports for each board in the homepage.
  • Fix miscellaneous incorrect or outdated information about ports throughout the Serial reference pages.

I'm not perfectly happy with putting the Serial object documentation under the "Parameters" section, since it's not really a parameter, but this follows the convention established in several other reference pages:

I welcome any proposals for better ways to do that.


Reference: http://forum.arduino.cc/index.php?topic=489217.msg3341839#msg3341839

The Serial reference pages contained large amounts of incorrect or extremely outdated information about which serial ports were available for each board.

- Add a table to the Serial reference homepage which lists the available ports for each board. Previously, this was done in a verbose manner that does not lend itself to the ever increasing information that must be conveyed on this topic as new boards are added.
- Rather than document syntax for each of the list of possible serial objects, only document each function signature and then point the reader to the list of available ports for each board in the homepage.
- Fix miscellaneous incorrect or outdated information about ports throughout the Serial reference pages.
@per1234 per1234 merged commit 633ff24 into arduino:master Feb 3, 2019
@per1234 per1234 deleted the update-serial-ports branch February 3, 2019 02:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant