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 28094 - Unclear wording
Summary: Unclear wording
Status: RESOLVED MOVED
Alias: None
Product: WHATWG
Classification: Unclassified
Component: MIME (show other bugs)
Version: unspecified
Hardware: PC All
: P2 normal
Target Milestone: Unsorted
Assignee: Gordon P. Hemsley
QA Contact: sideshowbarker+mimespec
URL:
Whiteboard: [good first bug]
Keywords:
Depends on:
Blocks: 28100
  Show dependency treegraph
 
Reported: 2015-02-24 18:46 UTC by Paul Irish
Modified: 2019-03-30 20:03 UTC (History)
4 users (show)

See Also:


Attachments

Description Paul Irish 2015-02-24 18:46:43 UTC
https://mimesniff.spec.whatwg.org/

In Section 8... There is plenty of
  "To determine the sniffed MIME type " ...
  "If the supplied MIME type is undefined, ….
  "The sniffed MIME type is the supplied MIME type."

This ends in being very unclear. I believe the second line is a bug of incompleteness, but it makes reading this section unclear.



Later on 
"If the supplied MIME type is an XML type, the sniffed MIME type is the supplied MIME type. Abort these steps."

This appears to be missing an "or" or something in the middle here.
Comment 1 Gordon P. Hemsley 2015-02-25 00:23:20 UTC
(In reply to Paul Irish from comment #0)
> https://mimesniff.spec.whatwg.org/
> 
> In Section 8... There is plenty of
>   "To determine the sniffed MIME type " ...
>   "If the supplied MIME type is undefined, ….
>   "The sniffed MIME type is the supplied MIME type."
> 
> This ends in being very unclear. I believe the second line is a bug of
> incompleteness, but it makes reading this section unclear.

Could you be more specify about what you feel is unclear? I may be biased (because I wrote those words), but they read fine to me. Both "sniffed MIME type" and "supplied MIME type" are defined terms.

> Later on 
> "If the supplied MIME type is an XML type, the sniffed MIME type is the
> supplied MIME type. Abort these steps."
> 
> This appears to be missing an "or" or something in the middle here.

This also reads fine to me. Where would you put the "or"? ("XML type" is a defined term, as well.)
Comment 2 Tab Atkins Jr. 2015-02-25 00:30:03 UTC
I think what Paul found unclear is that in the phrase "The X is the Y", all you're doing in English is equating the two, but you *mean* to be setting one to the other.  Which direction you intend the setting to go is unclear.

I usually try to use more explicit phrasing, like "Set X to Y" or similar.  In this case, it would be "Set <var>sniffed mime type</var> to <var>supplied mime type</var>" or similar.
Comment 3 Gordon P. Hemsley 2015-02-25 00:56:41 UTC
Upon consultation with Tab and Tantek, I've renamed "sniffed MIME type" to "computed MIME type", which should make things a little clearer:

https://github.com/whatwg/mimesniff/commit/ced82b8e18b153ca06ad9ebc44daa3c80af1c5c4

I'll have to think a little harder about comment 2.
Comment 4 Anne 2019-03-30 20:03:48 UTC
https://github.com/whatwg/mimesniff/issues/81 will take care of this, eventually.