w3c / webcodecs

WebCodecs is a flexible web API for encoding and decoding audio and video.
https://w3c.github.io/webcodecs/
Other
937 stars 131 forks source link

Rephrase non-normative uses of RFC2119 keywords #768

Closed tabatkins closed 4 months ago

tabatkins commented 4 months ago

Currently, on lines 2607 and 2715, the spec is using "may" in a note. To silence the Bikeshed warning complaining about this, it slaps a <span class=allow-2119> element around the sentence.

However, Bikeshed was correct to complain about this - using a normative 2119 keyword in a non-normative section is confusing at best and misleading at worst. The allow-2119 class is meant for false positives, like mentioning the month of May or quoting previous text that used the keyword, not for deliberately using the keyword in a confusable fashion.

I suggest both of these instances be changed to "can" or "might", and the <span> be removed.

Djuffin commented 4 months ago

Good point.