This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 26607 - Additional text needed for "Goals." [editorial]
Summary: Additional text needed for "Goals." [editorial]
Status: RESOLVED FIXED
Alias: None
Product: WHATWG
Classification: Unclassified
Component: URL (show other bugs)
Version: unspecified
Hardware: All All
: P2 minor
Target Milestone: Unsorted
Assignee: Anne
QA Contact: sideshowbarker+urlspec
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-08-19 15:43 UTC by Dan Appelquist
Modified: 2014-10-14 18:59 UTC (History)
1 user (show)

See Also:


Attachments

Description Dan Appelquist 2014-08-19 15:43:15 UTC
The current text of http://url.spec.whatwg.org/#goals starts with:

[[
The URL standard standardizes URLs, aiming to make them fully interoperable...
]]

Putting aside the fact that this is a tautology, I suggest that the spec might benefit from some small additional introductory text in this section which actually describes the goals of the document.

I suggest something like:

"The Uniform Resource Locator (URL) is a universal identifier.  This document standardizes the URL, specifies the parsing and serialization of URLs and their components and defines a URL API with the goal of maximizing interoperability. Additionally it seeks to:" [and then the existing bulleted list]
Comment 1 Anne 2014-10-14 18:22:30 UTC
I tried to remove the tautology. The rest seems covered under the first bullet point.

https://github.com/whatwg/url/commit/f142cb3037870fe83cfdf6885b79243adb19adce
Comment 2 Dan Appelquist 2014-10-14 18:50:11 UTC
Hi Anne - Thanks for that, but with all due respect, I disagree. I don't think the point is covered in the first bullet or any of the bullets. I think the URL standard should define URL at least once or at least say what it stands for. Please consider the naive reader who is trying to figure out what this document is about and what its point of view is? I know you would like to keep the text as simple as possible and I think this is a good goal, but I think this can be accomplished without adding any flowery language.
Comment 3 Anne 2014-10-14 18:53:04 UTC
Oh, you want the expansion of the term somewhere? I don't think the Goals section would be a good fit. Perhaps a History or a Preface section similar to https://encoding.spec.whatwg.org/ would be good.
Comment 4 Anne 2014-10-14 18:55:04 UTC
I've also been thinking about an abstract along these lines: "The URL Standard defines the internet's identifiers, URLs."
Comment 5 Dan Appelquist 2014-10-14 18:56:44 UTC
That's great - and yes.  I'm happy to work up something and submit it as a pull request if you like.
Comment 6 Anne 2014-10-14 18:59:28 UTC
Yeah that seems fine. If you don't get around to it feel free to file another bug.