This is an automated email from the ASF dual-hosted git repository. tvb pushed a commit to branch tristan/sboms in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit e6ed59ad7210853418d0e03920890d4f33906721 Author: Tristan van Berkom <[email protected]> AuthorDate: Sat Mar 1 14:10:29 2025 +0900 source.py: Added missing documentation for AliasSubstitution This is an opaque public data structure passed through SourceFetcher.fetch() which, if provided, must be used when invoking Source.translate_url() --- src/buildstream/source.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/buildstream/source.py b/src/buildstream/source.py index 81104db28..d92479d5f 100644 --- a/src/buildstream/source.py +++ b/src/buildstream/source.py @@ -262,6 +262,11 @@ class SourceError(BstError): @dataclass class AliasSubstitution: + """AliasSubstitution() + An opaque data structure which may be passed through + :func:`SourceFetcher.fetch() <buildstream.source.SourceFetcher.fetch>` and in such cases + must be provided to :func:`Source.translate_url() <buildstream.source.Source.translate_url>`. + """ _effective_alias: str _mirror: Union[SourceMirror, str] @@ -293,8 +298,9 @@ class SourceFetcher: Args: alias_override: The alias to use instead of the default one - defined by the :ref:`aliases <project_source_aliases>` field - in the project's config. + defined by the :ref:`aliases <project_source_aliases>` field in the + project's config. If provided, it must be used in when calling + :func:`Source.translate_url() <buildstream.source.Source.translate_url>`. Raises: :class:`.SourceError`
