-
-
Notifications
You must be signed in to change notification settings - Fork 726
Fixed code syntax related typo print.adoc #655
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
Conversation
Fixed code syntax related typo
Thank you!
@per1234 Doesn't Serial
need to be cursive in this case, too? Check the file from the German repo: https://github.com/arduino/reference-de/blob/master/Language/Functions/Communication/Serial/print.adoc, please.
@SeppPenner yes, since by "Serial" the "You can pass flash-memory based strings to Serial.print()
" text is referring to any HardwareSerial object, it should be in italics.
@per1234 Every occurance in the file or only in this case? E.g. in the syntax section it's italic, too but in the enumeration not.
It should also be done in in the "Notes and Warnings" section here:
For information on the asyncronicity of
Serial.print()
As to the lists in the "Description" section, one could argue it is fine as-is because it's example code specifically using the Serial
object. Or you could say this is demonstrating the various syntax of the function, in which case the italics would be better. If you want to submit a PR to fix this, I'll leave it up to you to decide.
As to the lists in the "Description" section, one could argue it is fine as-is because it's example code specifically using the Serial object. Or you could say this is demonstrating the various syntax of the function, in which case the italics would be better.
I agree with you. There are multiple possible interpretations. The PR makes all of them italic because it's more consistent. However, I understand the point that it shows example code as well.
Fixed code syntax related typo