[Documentation] Improve Documentation by Fixing Typos and Documentation Syntax

[animeshsrivastava24]

This is purely based on Documentation and Grammatical Problems.
@per1234 There are several small typos in the reference pages of various section . I have summarized them below, I was confused whether to raise this Issue or not.

1. https://www.arduino.cc/reference/en/language/variables/variable-scope--qualifiers/volatile/
   The color of the LANGUAGE Icon is Orange, please guide me whether it is a error or not.

While the variable is read, interrupts need to be disabled, so they can’t mess with the bits, while they >are read. There are several ways to do this:

LANGUAGE noInterrupts

2. https://www.arduino.cc/reference/en/language/variables/variable-scope--qualifiers/volatile/
   It should be program treat the variable

subsequent program treats the variable.

3. https://www.arduino.cc/reference/en/language/variables/utilities/progmem/
   Addition of commas.

There are small problems like this, if we look on a bigger scale we have a lot of typos on the whole which must be rectified.

[per1234]

The color of the LANGUAGE Icon is Orange, please guide me whether it is a error or not.

I agree that it would be better if the LANGUAGE tag was always colored the same. I don't know what the cause is or how to fix it and I don't consider it to be a huge problem so I'd prefer to focus on the many more important improvements we could make to the Arduino Language Reference.

It should be program treat the variable

Correct. Feel free to open a PR to fix it.

There are small problems like this, if we look on a bigger scale we have a lot of typos on the whole which must be rectified.

You're 100% correct. I have a long list of typos I have discovered while using the Arduino Language Reference. My intention was to do a comprehensive review of all the Language Reference content for typos and fix them all in a single PR but I'm currently trying to restrict my work to a maintenance role in the project.

If you find problems, feel free to submit a PR to fix them. I'm always available to review and merge pull requests.

[animeshsrivastava24]

@per1234 Sure, I'll look for typos and fix them. Also, can you please guide what should be a major thing to focus on to improve the Language Translator, except for fixing the typos. It would be useful to produce a major change in this process.

[animeshsrivastava24]

@per1234 I thought to reference this problem here :
In most of the files the mentioned functions , ( just an example) like digitalRead() , digitalWrite() lacks proper code syntax and are written in a normal fashion, simply like digitalRead() and digitalWrite() .
For example:
If we compare the files digitalWrite() and digitalRead() on arduino.cc, we find that digitalRead() present in the Notes and Warnings section is not present in a proper code syntax.
So, I am sending a PR by referencing this issue, since this Issue is based on both Fixing Typos and Documentation Syntax.

Please guide me.

[Edit .1 ] The given file: constants
Also requires a lot of code syntax addition, so I am little confused whether it is left intentionally?

[Edit. 2] I am also compiling a list of all the files which might need this correction and I will post it here.

[per1234]

Also requires a lot of code syntax addition, so I am little confused whether it is left intentionally?

I don't think it was intentional, but I don't know the mind of the original author of the text. Here's my own opinion on the topic:
#602 (comment)

[animeshsrivastava24]

Thank you so much for the reply. Sure, I'll follow the discussion mentioned by you.

[animeshsrivastava24]

@per1234 The document: begin() tells us about config argument and the values it can take:

An optional second argument configures the data, parity, and stop bits. The default is 8 data bits, no parity, one stop bit.

config: sets data, parity, and stop bits. Valid values are:

While reading, I felt that the documentation needs to specify the full forms of N, E and O present in the valid values of config. A person who may not be used to these terms may get confused.

N: No Parity
O: Odd Parity
E: Even Parity

Please guide me, should we include it in the documentation.