Skip to content

Commit c4db1dd

Browse files
authored
[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.
1 parent d2b9d98 commit c4db1dd

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

docs/package_index_json-specification.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -26,35 +26,35 @@ The root of the JSON index is an array of `packages`:
2626
```json
2727
{
2828
"packages": [
29-
PACKAGE_XXXX
30-
]
29+
PACKAGE_XXXX
30+
]
3131
}
3232
```
3333

3434
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:
3535

3636
```json
37-
{
38-
"name": "arduino",
39-
"maintainer": "Arduino LLC",
40-
"websiteURL": "http://www.arduino.cc/",
41-
"email": "[email protected]",
42-
43-
"platforms": [
44-
PLATFORM_AVR,
45-
PLATFORM_ARM,
46-
PLATFORM_XXXXX,
47-
PLATFORM_YYYYY,
48-
],
49-
50-
"tools": [
51-
TOOLS_COMPILER_AVR,
52-
TOOLS_UPLOADER_AVR,
53-
TOOLS_COMPILER_ARM,
54-
TOOLS_XXXXXXX,
55-
TOOLS_YYYYYYY,
56-
],
57-
}
37+
{
38+
"name": "arduino",
39+
"maintainer": "Arduino LLC",
40+
"websiteURL": "http://www.arduino.cc/",
41+
"email": "[email protected]",
42+
43+
"platforms": [
44+
PLATFORM_AVR,
45+
PLATFORM_ARM,
46+
PLATFORM_XXXXX,
47+
PLATFORM_YYYYY,
48+
],
49+
50+
"tools": [
51+
TOOLS_COMPILER_AVR,
52+
TOOLS_UPLOADER_AVR,
53+
TOOLS_COMPILER_ARM,
54+
TOOLS_XXXXXXX,
55+
TOOLS_YYYYYYY,
56+
],
57+
}
5858
```
5959

6060
The metadata fields are:

0 commit comments

Comments
 (0)