Skip to content

Commit 6a9a8e5

Browse files
committed
update descriptions and examples
1 parent 1dec90f commit 6a9a8e5

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

src/main/scala/io/viash/config/dependencies/Repository.scala

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,19 @@ import java.nio.file.{Path, Paths, Files}
2424
@description(
2525
"""Specifies a repository where dependency components can be found.
2626
|
27-
| - @[local](repo_local)
28-
| - @[git](repo_git)
29-
| - @[github](repo_github)
30-
| - @[vsh](repo_vsh)
27+
| - @[local](repo_local): This package (default).
28+
| - @[git](repo_git): A remote git repository.
29+
| - @[github](repo_github): A remote GitHub repository.
30+
| - @[vsh](repo_vsh): A Viash Hub package.
3131
|""")
32+
@exampleWithDescription(
33+
"""repositories:
34+
| - name: biobox
35+
| type: vsh
36+
| tag: 0.3.0
37+
|""",
38+
"yaml",
39+
"Definition of a Viash Hub package.")
3240
@exampleWithDescription(
3341
"""repositories:
3442
| - name: openpipelines-bio
@@ -40,6 +48,8 @@ import java.nio.file.{Path, Paths, Files}
4048
"Definition of a repository in the component config or package config.")
4149
@exampleWithDescription(
4250
"""dependencies:
51+
| - name: arriba
52+
| repository: vsh://biobox@0.3.0
4353
| - name: qc/multiqc
4454
| repository:
4555
| type: github

0 commit comments

Comments
 (0)