-
-
Notifications
You must be signed in to change notification settings - Fork 732
Truncation and Round Off Addition #606
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
Addressing the Issue arduino#579. Information related to Truncation and Round Off Addition is added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for this @animeshsrivastava24. It's very well written but I have a couple of requests to improve the structure of the page:
Move detailed information to the "Notes and Warnings" section
- The Description section of a reference page should contain a beginner friendly description. More advanced details should be added to a Notes and Warnings section near the bottom of the page so that beginners won't be overwhelmed with information before they reach the Syntax/Parameters and Example Code sections. The
float
reference page was already a bit heavy on complex details in the Description section and the information you added makes it far too long.
Please move all the description text from "Floats have only 6-7 decimal digits of precision." onward to a Notes and Warnings section. You can see an example of a Notes and Warnings section in this page:
https://github.com/arduino/reference-en/blob/master/Language/Functions/Math/constrain.adoc
Don't create multiple Example Code sections
The reference page should only contain a single Example Code section. The code examples you have added are great and should be in code blocks, but you should not create an Example Code section for each of them.
Once those changes are made, I'll look over the PR again to see if I maybe have a few other small requests to make but it's better that these larger structural changes are made first.
@animeshsrivastava24 why did you close this? I think it is a very useful and needed pull request. I only am hoping you could make some modifications to the formatting of it as I described above. |
@per1234 Definitely, I will make the modifications and format it. Sorry, for the inconvenience caused. |
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Co-Authored-By: per1234 <[email protected]>
Thanks @animeshsrivastava24 ! |
Addressing the Issue #579. Information related to Truncation and Round Off Addition is added.