diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-09-01 18:19:50 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-09-02 18:34:10 +0900 |
| commit | 559b6fbc16af97410c902129200325fbf62854d1 (patch) | |
| tree | f2251776d591cb0ddee7aef5bdc275de50ebc996 | |
| parent | f8b06acc4d7cf307e1106140330ad545023d7e81 (diff) | |
| download | buildstream-559b6fbc16af97410c902129200325fbf62854d1.tar.gz | |
source.py: Fixing docs link formatting to be consistent.
| -rw-r--r-- | buildstream/source.py | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/buildstream/source.py b/buildstream/source.py index f806546fb..92aedf969 100644 --- a/buildstream/source.py +++ b/buildstream/source.py @@ -351,10 +351,10 @@ class Source(Plugin): Args: ref (simple object): The internal source reference to set, or ``None`` node (dict): The same dictionary which was previously passed - to :func:`~buildstream.source.Source.configure` + to :func:`Plugin.configure() <buildstream.plugin.Plugin.configure>` - See :func:`~buildstream.source.Source.get_ref` for a discussion on - the *ref* parameter. + See :func:`Source.get_ref() <buildstream.source.Source.get_ref>` + for a discussion on the *ref* parameter. .. note:: @@ -384,8 +384,8 @@ class Source(Plugin): backend store allows one to query for a new ref from a symbolic tracking data without downloading then that is desirable. - See :func:`~buildstream.source.Source.get_ref` for a discussion on - the *ref* parameter. + See :func:`Source.get_ref() <buildstream.source.Source.get_ref>` + for a discussion on the *ref* parameter. """ # Allow a non implementation return None @@ -435,7 +435,7 @@ class Source(Plugin): :class:`.SourceError` Default implementation is to call - :func:`~buildstream.source.Source.stage`. + :func:`Source.stage() <buildstream.source.Source.stage>`. Implementors overriding this method should assume that *directory* already exists. @@ -523,8 +523,10 @@ class Source(Plugin): def mark_download_url(self, url): """Identifies the URL that this Source uses to download - This must be called during :func:`~buildstream.plugin.Plugin.configure` if - :func:`~buildstream.source.Source.translate_url` is not called. + This must be called during + :func:`Plugin.configure() <buildstream.plugin.Plugin.configure>` if + :func:`Source.translate_url() <buildstream.source.Source.translate_url>` + is not called. Args: url (str): The url used to download |