Skip to content

Clarify dep type yielded by element.dependencies #2000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify dep type yielded by element.dependencies #2000

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/buildstream/element.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,11 @@ def sources(self) -> Iterator["Source"]:
def dependencies(
self, selection: Optional[Sequence["Element"]] = None, *, recurse: bool = True
) -> Iterator["Element"]:
"""A generator function which yields the build dependencies of the given element.
"""A generator function which yields dependencies of the given element.

Normally `dependencies` yields build dependencies. If the given element is the result of a
previous call to `dependencies` or `selection` is set to a dependency of the given element
then `dependencies` yields runtime dependencies.

This generator gives the Element access to all of the dependencies which it is has
access to at build time. As explained in :ref:`the dependency type documentation <format_dependencies_types>`,
Expand Down