search

Elchi3 / mdn-doc-tests

:no_entry_sign: UNMAINTAINED :no_entry_sign: This used to check MDN docs against some tests and cleanup tasks while editing, but add-on SDK based add-ons are obsolete. Use https://github.com/mdn/doc-linter-webextension and https://github.com/mdn/doc-linter-rules instead.
Mozilla Public License 2.0
10 stars 8 forks source link

Require hidden explanatory text for macros that rely on data #210

Closed Elchi3 closed 7 years ago

Elchi3 commented 7 years ago

If a contributor edits a page and wants to change compatibility data or CSS property data they will only see macros like {{Compat}} or {{cssinfo}}. They will wonder where those macros are and how they are getting the information, so that they can contribute to it.

That's why for {{Compat}} we have started to put an edit-only text into the doc, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy$edit

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

This extension should force us to always provide

SebastianZ commented 7 years ago

Should there be a single comment for all macros or one comment for each?

Sebastian