Skip to content

Commit

Permalink
docs: clarify use cases for declare_dependency()
Browse files Browse the repository at this point in the history
  • Loading branch information
LaserEyess authored and eli-schwartz committed Jan 21, 2025
1 parent cef9c33 commit 0b9baf5
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/yaml/functions/declare_dependency.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ returns: dep
description: |
This function returns a [[@dep]] object that
behaves like the return value of [[dependency]] but is
internal to the current build. The main use case for this is in
internal to the current build. One use case for this is in
subprojects. This allows a subproject to easily specify how it should
be used. This makes it interchangeable with the same dependency that
is provided externally by the system.
is provided externally by the system. Another common use case is to
declare project targets as dependencies so they may be used as
dependencies of other build targets.
kwargs:
compile_args:
Expand Down Expand Up @@ -49,7 +51,7 @@ kwargs:
description: |
extra files to add to targets.
mostly used for IDE integration.
version:
type: str
description: |
Expand Down

0 comments on commit 0b9baf5

Please sign in to comment.