Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
per1234 merged 1 commit into arduino:master from animeshsrivastava24:patch-27
Jul 5, 2019

Conversation

Copy link
Contributor

@animeshsrivastava24 animeshsrivastava24 commented Jul 4, 2019

Fixed code syntax related typo

Fixed code syntax related typo
@per1234 per1234 merged commit de1dd80 into arduino:master Jul 5, 2019
Copy link
Collaborator

per1234 commented Jul 5, 2019

Thank you!

animeshsrivastava24 reacted with thumbs up emoji

Copy link
Contributor

SeppPenner commented Jul 11, 2019
edited
Loading

@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.

Copy link
Collaborator

per1234 commented Jul 11, 2019

@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.

Copy link
Contributor

SeppPenner commented Jul 11, 2019
edited
Loading

@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.

Copy link
Collaborator

per1234 commented Jul 11, 2019

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.

Copy link
Contributor

SeppPenner commented Jul 11, 2019
edited
Loading

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /