Example code on reference pages do not follow the Arduino code format standard
- Dominant language
- Java
- Stars
- 14.6k
- Forks
- 7k
- PR merge metrics
- No merged PRs in 30d
Description
**Tools > Auto Format** in the Arduino IDE has established a standard of formatting for all Arduino sketches. It's important to teach beginners to be consistent in whatever code formatting style they choose. Unfortunately Arduino's example code doesn't always follow their own standard.
I recommend using the ["examples_formatter" script](https://github.com/arduino/Arduino/blob/master/build/shared/examples_formatter.sh), or the Arduino IDE's **Tools > Auto Format** configured with the [examples_formatter.conf file](https://github.com/arduino/Arduino/blob/master/build/shared/examples_formatter.conf) on all example code in the Arduino reference pages.
Contributor guide
Research direction
Start with build/shared/examples_formatter.sh and build/shared/examples_formatter.conf, then identify the example code used on the Arduino reference pages. Run the formatter or use Arduino IDE Tools > Auto Format with that configuration, and confirm the reference-page examples consistently follow the established format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100