Commit a6dbf5fc authored by Tristan Van Berkom's avatar Tristan Van Berkom
Browse files

source.py: Fixing docs link formatting to be consistent.

parent 2a27b9c4

buildstream/source.py

+10 −8
Original line number Original line Diff line number Diff line
@@ -290,10 +290,10 @@ class Source(Plugin): 
        Args:

        Args:

           ref (simple object): The internal source reference to set, or ``None``

           ref (simple object): The internal source reference to set, or ``None``

           node (dict): The same dictionary which was previously passed

           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

        See :func:`Source.get_ref() <buildstream.source.Source.get_ref>`

        the *ref* parameter.

        for a discussion on the *ref* parameter.





        .. note::

        .. note::
@@ -317,8 +317,8 @@ class Source(Plugin): 
        backend store allows one to query for a new ref from a symbolic

        backend store allows one to query for a new ref from a symbolic

        tracking data without downloading then that is desirable.

        tracking data without downloading then that is desirable.





        See :func:`~buildstream.source.Source.get_ref` for a discussion on

        See :func:`Source.get_ref() <buildstream.source.Source.get_ref>`

        the *ref* parameter.

        for a discussion on the *ref* parameter.

        """

        """

        # Allow a non implementation

        # Allow a non implementation

        return None

        return None
@@ -362,7 +362,7 @@ class Source(Plugin): 
           :class:`.SourceError`

           :class:`.SourceError`





        Default implementation is to call

        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*

        Implementors overriding this method should assume that *directory*

        already exists.

        already exists.
@@ -450,8 +450,10 @@ class Source(Plugin): 
    def mark_download_url(self, url):

    def mark_download_url(self, url):

        """Identifies the URL that this Source uses to download

        """Identifies the URL that this Source uses to download





        This must be called during :func:`~buildstream.plugin.Plugin.configure` if

        This must be called during

        :func:`~buildstream.source.Source.translate_url` is not called.

        :func:`Plugin.configure() <buildstream.plugin.Plugin.configure>` if

        :func:`Source.translate_url() <buildstream.source.Source.translate_url>`

        is not called.





        Args:

        Args:

           url (str): The url used to download

           url (str): The url used to download