Skip to content

Commit 3200286

Browse files
authored
Move IDE 2.x configuration file link above supplemental link
Arduino IDE 2.x allows the user to customize the output of the "Auto Format" feature via a configuration file. This system is documented in the "Customizing the Auto Formatter Feature" tutorial. Arduino's standard formatter configuration file is offered as part of the tutorial. Originally, the full YAML code of the standard configuration was included in the tutorial page itself. Since that consisted as a large block of cryptic code, it made sense to place it at the bottom of that section of the tutorial, after the section's prose content, following this structure: - Introduction - Supplemental note - Configuration code Since that time, the code content has been replaced by a link to the source file. After this change, the placement of this essential link (which is less visibly prominent in the page) makes less sense. The content will be easier to follow with the new structure: - Introduction - Configuration file link - Supplemental note
1 parent cacc78d commit 3200286

File tree

1 file changed

+2
-2
lines changed
  • content/software/ide-v2/tutorials/ide-v2-customize-auto-formatter

1 file changed

+2
-2
lines changed

Diff for: content/software/ide-v2/tutorials/ide-v2-customize-auto-formatter/content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ If you add a `.clang-format` configuration file to the root of a sketch, the Ard
6363

6464
Here you can find the default formatting file used in the Arduino IDE 2.0. If you wish to customize how your auto formatting acts in the IDE then starting with this file is a good idea.
6565

66-
***Please note that the custom configuration file completely overrides the Arduino default configuration, rather than merging with it. Any configuration option you don't set in your custom file will be set to the ClangFormat default value.***
67-
6866
https://raw.githubusercontent.com/arduino/tooling-project-assets/main/other/clang-format-configuration/.clang-format
6967

68+
***Please note that the custom configuration file completely overrides the Arduino default configuration, rather than merging with it. Any configuration option you don't set in your custom file will be set to the ClangFormat default value.***
69+
7070
## Conclusion
7171

7272
In this tutorial we went through how to customize the behavior of the `CTRL + T` / `CMD + T` auto formatter command in the Arduino IDE 2.0. This tutorial also shows the different scopes that are available for the auto formatter configuration.

0 commit comments

Comments
 (0)