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

Add test specifications to the top of test files #211

Closed Elchi3 closed 8 years ago

Elchi3 commented 8 years ago

A specification or documentation for our tests would be very useful. I can imagine to have a comment block at the top of our tests.

For example, in mdn-doc-tests/data/tests/different-locale-links.js:

/*
 *  Title: Test for wrong locales in links (<a href>).

 *  Example 1: If you are in a German document, internal links should 
 *  contain the "de" locale and not e.g. "en-US".

 *  Implementation notes: This test compares the current locale in the slug (document.URL) 
 *  with the locale used in internal links (<a href>)

 */