Skip to content

[DOC] Inconsistency in Stream documentation and derived libraries (Serial, Ethernet, SD, Wire) #2919

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

Closed
q2dg opened this issue Apr 6, 2015 · 2 comments
Assignees
Labels
Component: Documentation Related to Arduino's documentation content Type: Duplicate Another item already exists for this topic
Milestone

Comments

@q2dg
Copy link

q2dg commented Apr 6, 2015

In http://arduino.cc/en/Reference/Stream says "Some of the libraries that rely on Stream include: Serial, Wire, Ethernet Client, Ethernet Server, SD". When I go to Reference page of these libraries -except Serial- I can see listed some of Stream methods, like .available(), print(), .read()...but not others like find/findUntil(), readBytes()/readBytesUntil(), readString()/readStringUntil(), parseInt()/parseFloat() and setTimeout()... If they are derived from Stream, can I infer these methods are inherited too?

I think documentation should be refactored to list in one point common methods (Stream page) and then, in library reference pages a link to these (cleaning some redundancies). Maybe I'm stupid...but nowadays it doesn't clear if I can write EthernetServer.readString() or not, for instance.

@ffissore ffissore added the Component: Documentation Related to Arduino's documentation content label Apr 7, 2015
@per1234
Copy link
Collaborator

per1234 commented May 2, 2015

I agree. When I was learning to use the Ethernet library it was only by coming across an example sketch that I realized I could use the Stream functions. It was very confusing to see the usage of functions that were not shown in the Ethernet library documentation. Even though it says "read() inherits from the Stream utility class" at the top of the Ethernet library Client class read() documentation, that still means nothing to the beginner that Arduino is intended to be accessible to. In the EthernetUDP class read() documentation it is not even mentioned.

@agdl agdl added this to the Release 1.6.6 milestone Sep 4, 2015
@agdl agdl added the Type: Duplicate Another item already exists for this topic label Sep 4, 2015
@agdl
Copy link
Member

agdl commented Sep 4, 2015

@q2dg I'm marking this as duplicate and closing this because is a duplicate of #3718

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Related to Arduino's documentation content Type: Duplicate Another item already exists for this topic
Projects
None yet
Development

No branches or pull requests

4 participants