]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] gh-82151: Update and improve urlsplit docstring (#152985) (#153155)
authorSenthil Kumaran <senthil@python.org>
Tue, 7 Jul 2026 00:24:20 +0000 (17:24 -0700)
committerGitHub <noreply@github.com>
Tue, 7 Jul 2026 00:24:20 +0000 (17:24 -0700)
gh-82151: Update and improve urlsplit docstring (#152985)

Slightly improved wording for % escapes. Consistent with rest of the doc.

---------

(cherry picked from commit ad54b91b9fa4c5d12f155bb09138dff21a2bdec3)

Co-authored-by: Pranav Choudhary <chaudharyypranav@gmail.com>
Co-authored-by: idomic <michael.ido@gmail.com>
Doc/library/urllib.parse.rst

index f893039c9ac83a1ca77edd240b901b370cf1ecc6..82f31c6bcf532f5759242e1bf03c7bea43cd3f7e 100644 (file)
@@ -56,11 +56,18 @@ or on combining URL components into a URL string.
    :class:`SplitResult` or :class:`SplitResultBytes`.
    This corresponds to the general structure of a URL:
    ``scheme://netloc/path?query#fragment``.
-   Each tuple item is a string, possibly empty. The components are not broken up
-   into smaller parts (for example, the network location is a single string), and %
-   escapes are not expanded. The delimiters as shown above are not part of the
-   result, except for a leading slash in the *path* component, which is retained if
-   present.  For example:
+   Each tuple item is a string, possibly empty.
+
+   The delimiters as shown above are not part of the result, except for a
+   leading slash in the *path* component, which is retained if present.
+
+   Additionally, the netloc property is broken down into these additional
+   attributes added to the returned object: username, password, hostname, and
+   port.
+
+   Percent-encoded sequences are not decoded.
+
+   For example:
 
    .. doctest::
       :options: +NORMALIZE_WHITESPACE