doc: remove "everything everything" from ParseUrl doc ()

Closes: .
This commit is contained in:
Michael Ford 2023-02-24 01:34:48 +08:00 committed by GitHub
parent ad97d7b9db
commit ca88fc34c3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 20 deletions

View file

@ -265,12 +265,12 @@ static void ParseFragment(struct UrlParser *u, struct UrlView *h) {
* since it's the most non-deterministically defined field of them all. * since it's the most non-deterministically defined field of them all.
* *
* Please note this is a URL parser, not a URI parser. Which means we * Please note this is a URL parser, not a URI parser. Which means we
* support everything everything the URI spec says we should do except * support everything the URI spec says we should do except for the
* for the things we won't do, like tokenizing path segments into an * things we won't do, like tokenizing path segments into an array
* array and then nesting another array beneath each of those for * and then nesting another array beneath each of those for storing
* storing semicolon parameters. So this parser won't make SIP easy. * semicolon parameters. So this parser won't make SIP easy. What it
* What it can do is parse HTTP URLs and most URIs like s:opaque, * can do is parse HTTP URLs and most URIs like s:opaque, better in
* better in fact than most things which claim to be URI parsers. * fact than most things which claim to be URI parsers.
* *
* @param s is value like `/hi?x=y&z` or `http://a.example/hi#x` * @param s is value like `/hi?x=y&z` or `http://a.example/hi#x`
* @param n is byte length and -1 implies strlen * @param n is byte length and -1 implies strlen

View file

@ -1431,13 +1431,13 @@ function ParseHttpDateTime(rfc1123) end
--- it's the most non-deterministically defined field of them all. --- it's the most non-deterministically defined field of them all.
--- ---
--- Please note this is a URL parser, not a URI parser. Which --- Please note this is a URL parser, not a URI parser. Which
--- means we support everything everything the URI spec says we --- means we support everything the URI spec says we should do
--- should do except for the things we won't do, like tokenizing --- except for the things we won't do, like tokenizing path
--- path segments into an array and then nesting another array --- segments into an array and then nesting another array beneath
--- beneath each of those for storing semicolon parameters. So --- each of those for storing semicolon parameters. So this parser
--- this parser won't make SIP easy. What it can do is parse HTTP --- won't make SIP easy. What it can do is parse HTTP URLs and most
--- URLs and most URIs like data:opaque, better in fact than most --- URIs like data:opaque, better in fact than most things which
--- things which claim to be URI parsers. --- claim to be URI parsers.
--- ---
---@nodiscard ---@nodiscard
function ParseUrl(url, flags) end function ParseUrl(url, flags) end

View file

@ -1374,13 +1374,12 @@ FUNCTIONS
it's the most non-deterministically defined field of them all. it's the most non-deterministically defined field of them all.
Please note this is a URL parser, not a URI parser. Which Please note this is a URL parser, not a URI parser. Which
means we support everything everything the URI spec says we means we support everything the URI spec says we should do except
should do except for the things we won't do, like tokenizing for the things we won't do, like tokenizing path segments into
path segments into an array and then nesting another array an array and then nesting another array beneath each of those for
beneath each of those for storing semicolon parameters. So storing semicolon parameters. So this parser won't make SIP easy.
this parser won't make SIP easy. What it can do is parse HTTP What it can do is parse HTTP URLs and most URIs like data:opaque,
URLs and most URIs like data:opaque, better in fact than most better in fact than most things which claim to be URI parsers.
things which claim to be URI parsers.
IsAcceptablePath(str) → bool IsAcceptablePath(str) → bool
Returns true if path doesn't contain ".", ".." or "//" segments Returns true if path doesn't contain ".", ".." or "//" segments