From e37567da28edb65ec5dbfc0f7dc3ee90c69ba254 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 9 Jul 2020 20:42:52 -0700 Subject: [PATCH 1/2] 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. --- docs/package_index_json-specification.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/package_index_json-specification.md b/docs/package_index_json-specification.md index b0077d79931..02375250dcb 100644 --- a/docs/package_index_json-specification.md +++ b/docs/package_index_json-specification.md @@ -26,8 +26,8 @@ The root of the JSON index is an array of `packages`: ```json { "packages": [ - PACKAGE_XXXX - ] + PACKAGE_XXXX + ] } ``` @@ -41,19 +41,19 @@ The root of the JSON index is an array of `packages`: "email": "packages@arduino.cc", "platforms": [ - PLATFORM_AVR, - PLATFORM_ARM, - PLATFORM_XXXXX, - PLATFORM_YYYYY, + PLATFORM_AVR, + PLATFORM_ARM, + PLATFORM_XXXXX, + PLATFORM_YYYYY, ], "tools": [ - TOOLS_COMPILER_AVR, - TOOLS_UPLOADER_AVR, - TOOLS_COMPILER_ARM, - TOOLS_XXXXXXX, - TOOLS_YYYYYYY, - ], + TOOLS_COMPILER_AVR, + TOOLS_UPLOADER_AVR, + TOOLS_COMPILER_ARM, + TOOLS_XXXXXXX, + TOOLS_YYYYYYY, + ], } ``` From 361ca7325c219a2f0f55e21fb05f5cde2f719302 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 9 Jul 2020 20:46:32 -0700 Subject: [PATCH 2/2] 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. --- docs/package_index_json-specification.md | 42 ++++++++++++------------ 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/package_index_json-specification.md b/docs/package_index_json-specification.md index 02375250dcb..4d5293477aa 100644 --- a/docs/package_index_json-specification.md +++ b/docs/package_index_json-specification.md @@ -34,27 +34,27 @@ The root of the JSON index is an array of `packages`: 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: