Skip to content

Commit

Permalink
Improve the scope documentation
Browse files Browse the repository at this point in the history
fix the list formatting and other minor tweaks
  • Loading branch information
Grifs committed Jan 16, 2025
1 parent 48170f5 commit 8f81835
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions src/main/scala/io/viash/config/Scope.scala
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,24 @@ enum ScopeEnum {

@description(
"""Defines the scope of the component.
|`test`: only available during testing; components aren't published.
|`private`: only meant for internal use within a workflow or other component.
|`public`: core component or workflow meant for general use.""")
|
|- `test`: only available during testing; components aren't published
|- `private`: only meant for internal use within a workflow or other component
|- `public`: core component or workflow meant for general use""")
case class Scope(
@description(
"""test: image is only used during testing and is transient
|private: image is published in the registry
|public: image is published in the registry""")
"""Defines whether the image is published or not.
|
|- `test`: image is only used during testing and is transient
|- `private`: image is published in the registry
|- `public`: image is published in the registry""")
image: ScopeEnum,
@description(
"""test: target folder is only used during testing and is transient
|private: target folder can be published in target/private or target/dependencies/private
|public: target is published in target/executable or target/nextflow"""
)
"""Defines the target location of the component.
|
|- `test`: target folder is only used during testing and is transient
|- `private`: target folder can be published in target/_private or target/dependencies/_private
|- `public`: target is published in target/executable or target/nextflow""")
target: ScopeEnum,
)

Expand Down

0 comments on commit 8f81835

Please sign in to comment.