Skip to content

Commit a1b360c

Browse files
committed
per CR: explain in much more detail
1 parent 6ff5269 commit a1b360c

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

src/hyperlink/_url.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -815,9 +815,18 @@ class URL(object):
815815
that starts with a slash.
816816
userinfo (Text): The username or colon-separated
817817
username:password pair.
818-
uses_netloc (bool): Indicates whether ``://`` will appear to separate
819-
the scheme from the path, even in cases where no host is present.
820-
May be implied by scheme, or set explictly.
818+
uses_netloc (Optional[bool]): Indicates whether ``://`` (the "netloc
819+
separator") will appear to separate the scheme from the *path* in
820+
cases where no host is present. Setting this to ``True`` is a
821+
non-spec-compliant affordance for the common practice of having URIs
822+
that are *not* URLs (cannot have a 'host' part) but nevertheless use
823+
the common ``://`` idiom that most people associate with URLs;
824+
e.g. ``message:`` URIs like ``message://message-id`` being
825+
equivalent to ``message:message-id``. This may be inferred based on
826+
the scheme depending on whether :func:`register_scheme` has been
827+
used to register the scheme and should not be passed directly unless
828+
you know the scheme works like this and you know it has not been
829+
registered.
821830
822831
All of these parts are also exposed as read-only attributes of
823832
URL instances, along with several useful methods.

0 commit comments

Comments
 (0)