Skip to content

Commit

Permalink
Clarify relative path resolution in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
prkumar committed Apr 3, 2019
1 parent b91a561 commit 6bd21b8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/source/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ path from :class:`base_url`, which we covered above:
.. note::

To build a request's absolute URL, Uplink resolves the relative path
against the :obj:`Consumer`'s base url according to `RFC 3986`_. For
a simplified overview, see `these recommendations and examples`_
from Retrofit's documentation, as they are also relevant to how
Uplink handles resolving URLs.
against the :obj:`Consumer`'s base url using :func:`urljoin
<urllib.parse.urljoin>`, which implements the `RFC 3986`_ standards.
For a simplified overview of these standards, see `these
recommendations and examples`_ from Retrofit's documentation.

.. _RFC 3986: https://tools.ietf.org/html/rfc3986#section-5
.. _these recommendations and examples: https://square.github.io/retrofit/2.x/retrofit/retrofit2/Retrofit.Builder.html#baseUrl-okhttp3.HttpUrl-
Expand Down

0 comments on commit 6bd21b8

Please sign in to comment.