On Tue, Sep 15, 2015 at 4:24 PM, Ehsan Akhgari <ehsan.akhg...@gmail.com> wrote: > On 2015-09-15 7:31 AM, Paul Rouget wrote: >> >> I believe the WebIDL files should play this role. But they are missing >> comments and events. > > > WebIDL files are not a suitable place for documentation to live, since they > require review from DOM peers who are typically overloaded individuals, and > it would be nice to not make them review documentation changes. > > I don't understand why the dev-doc-needed based workflow that we use to > document other parts of the Web platform is insufficient for this API.
Other parts of the web platforms usually have a reference: the specification. So there’s a minimal documentation already available. Which is not the case with the API with no standardization efforts, like the Browser API. And we can’t use dev-doc-needed to keep a reference up to date (too often, we forget about the flag, and like Chris said, the MDN editors are very busy too), and that’s clearly the responsibility of the developer, not of the MDN team. -- Paul _______________________________________________ dev-b2g mailing list dev-b2g@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-b2g
