Unverified Commit c4db1ddb authored by per1234's avatar per1234 Committed by GitHub

[skip changelog] Use consistent indentation style in example snippets of...

[skip changelog] Use consistent indentation style in example snippets of package_index.json specification (#815)

* Use consistent index size for snippets in package_index.json specification

The predominant index size in the example snippets (as well as in Arduino's official package_index.json file) is two spaces. However, at some places in the example snippets indents of three or four spaces were used.

* Use true indentation level for package definition example snippet

All other example snippets in the documentation use the indentation level they will have in the full document, so for consistency the package definition snippet should do the same.
parent d2b9d98f
......@@ -26,35 +26,35 @@ The root of the JSON index is an array of `packages`:
```json
{
"packages": [
PACKAGE_XXXX
]
PACKAGE_XXXX
]
}
```
3rd party vendors should use a single `PACKAGE_XXXX` that is a dictionary map with the vendor's metadata, a list of `PLATFORMS` and a list of `TOOLS`. For example:
```json
{
"name": "arduino",
"maintainer": "Arduino LLC",
"websiteURL": "http://www.arduino.cc/",
"email": "packages@arduino.cc",
"platforms": [
PLATFORM_AVR,
PLATFORM_ARM,
PLATFORM_XXXXX,
PLATFORM_YYYYY,
],
"tools": [
TOOLS_COMPILER_AVR,
TOOLS_UPLOADER_AVR,
TOOLS_COMPILER_ARM,
TOOLS_XXXXXXX,
TOOLS_YYYYYYY,
],
}
{
"name": "arduino",
"maintainer": "Arduino LLC",
"websiteURL": "http://www.arduino.cc/",
"email": "packages@arduino.cc",
"platforms": [
PLATFORM_AVR,
PLATFORM_ARM,
PLATFORM_XXXXX,
PLATFORM_YYYYY,
],
"tools": [
TOOLS_COMPILER_AVR,
TOOLS_UPLOADER_AVR,
TOOLS_COMPILER_ARM,
TOOLS_XXXXXXX,
TOOLS_YYYYYYY,
],
}
```
The metadata fields are:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment