Skip to content

Links missing to reference for Stream and Print classes in the Library Style Guide #773

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

Open
laserguru opened this issue Jan 14, 2023 · 4 comments

Comments

@laserguru
Copy link

In the body of the Library Style Guide users are asked to, quote:

Use the established core libraries and styles.
[...]

  • Use the Stream and Print classes when dealing with byte streams.

However there aren't any links to the reference for those classes. Moreover I don't think there is documentation for them yet in these new docs. There's documentation for the Stream class in the Reference, but it seems there isn't any for the Print class (at least judging by a quick search)

@per1234
Copy link
Contributor

per1234 commented Jan 14, 2023

it seems there isn't any for the Print class (at least judging by a quick search)

The need to add general purpose Print class documentation to the Arduino Language Reference is tracked here:

arduino/reference-en#786

@marqdevx
Copy link
Member

Can I close this issue as this is handled externally?

@per1234
Copy link
Contributor

per1234 commented Jan 23, 2023

Hi @marqdevx. We can break the resolution of this request into individual tasks. One of those tasks is for work in the arduino/reference-en repository, so that specific task must be handled externally.

However, the other two tasks are for work in this repository. So no it should not be closed.

I'll list the tasks:

Add Stream class documentation link to Library Style Guide

The task is to change the content of the "Arduino Style Guide for Creating Libraries", which is hosted in this repository.

The Stream class documentation is here:

https://www.arduino.cc/reference/en/language/functions/communication/stream/

So this task is not blocked by any external work and can be done at any time.

Write Print class documentation

The task is to write and add the missing documentation content in the arduino/reference-en repository.

That task is tracked here: arduino/reference-en#786

Add Print class documentation link to tutorial

The task is to change the content of the "Arduino Style Guide for Creating Libraries", which is hosted in this repository.

The Print class documentation does not currently exist so this task is blocked by arduino/reference-en#786

@igmtz
Copy link
Contributor

igmtz commented Apr 5, 2023

Hello @per1234 can I help in some of this tasks? Is there any example of how the links must be added to the Library Style Guide Page?

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

No branches or pull requests

4 participants