Skip to content

Commit 68df0b9

Browse files
committed
Make some minor updates to the libraries input documentation
This makes some small corrections and improvements to the existing documentation for the action's libraries input.
1 parent 821c7fa commit 68df0b9

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Keys:
5050

5151
Keys:
5252
- `source-url` - download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
53-
- `source-path` - path to install as a library. Paths are relative to the root folder of the archive. If the archive doesn't have a root folder, use `..` as `source-path` to install from the archive root. The default is to install from the root folder of the archive.
53+
- `source-path` - path to install as a library. Paths are relative to the root folder of the archive, or the root of the archive if it has no root folder. The default is to install from the root folder of the archive.
5454
- `destination-name` - folder name to install the library to. By default, the folder will be named according to the source archive or subfolder name.
5555

5656
### `sketch-paths`

compilesketches/compilesketches.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class CompileSketches:
4848
cli_version -- version of the Arduino CLI to use
4949
fqbn_arg -- fully qualified board name of the board to compile for. Space separated list with Boards Manager URL if
5050
needed
51-
libraries -- space-separated list of libraries to install
51+
libraries -- YAML-format or space-separated list of libraries to install
5252
sketch_paths -- space-separated list of paths containing sketches to compile. These paths will be searched
5353
recursively for sketches.
5454
verbose -- set to "true" for verbose output ("true", "false")
@@ -242,7 +242,7 @@ def sort_dependency_list(self, dependency_list):
242242
# All other URLs are assumed to be downloads
243243
sorted_dependencies.download.append(dependency)
244244
elif self.dependency_source_path_key in dependency:
245-
# Libraries with source-path and no source-url are assumed to be paths
245+
# Dependencies with source-path and no source-url are assumed to be paths
246246
sorted_dependencies.path.append(dependency)
247247
else:
248248
# All others are Library/Board Manager names
@@ -285,7 +285,9 @@ def install_platforms_from_board_manager(self, platform_list, additional_url_lis
285285
self.run_arduino_cli_command(command=core_install_command, enable_output=self.get_run_command_output_level())
286286

287287
def get_manager_dependency_name(self, dependency):
288-
"""Return the appropriate name value for a repository dependency
288+
"""Return the appropriate name value for a manager dependency. This allows the NAME@VERSION syntax to be used
289+
with the special "latest" ref for the sake of consistency (though the documented approach is to use the version
290+
key to specify version.
289291
290292
Keyword arguments:
291293
dependency -- dictionary defining the Library/Board Manger dependency

0 commit comments

Comments
 (0)