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

Issue 186: Broaden jsref-with-params test #204

Closed SebastianZ closed 7 years ago

SebastianZ commented 8 years ago

Broadened the test for {{JSRef}} params to also check {{csssyntax}}, {{cssinfo}} and {{svginfo}} and improved the output error messages.

Sebastian

Elchi3 commented 7 years ago

I didn't notice the rule "The parameters of the %s macro are unnecessary, because they will be fetched from the slug, so they should be removed." when reading the code at first. Is this testable?

I start feel that tests should have a comment on top explaining what their purpose is or the cases they are dealing with. I mean yes, you can figure out the rules from the code and the tests, but this took me a minute or two.

Elchi3 commented 7 years ago

This works as expected otherwise. Test for the slug case would be ideal, but feel free to merge without. r+

SebastianZ commented 7 years ago

I didn't notice the rule "The parameters of the %s macro are unnecessary, because they will be fetched from the slug, so they should be removed." when reading the code at first. Is this testable?

We'd need to load some real page to check that. Or can you think of a way to fake the URL?

I start feel that tests should have a comment on top explaining what their purpose is or the cases they are dealing with. I mean yes, you can figure out the rules from the code and the tests, but this took me a minute or two.

Yes, we should add some comments. File an issue?

Sebastian

Elchi3 commented 7 years ago

We'd need to load some real page to check that. Or can you think of a way to fake the URL?

No idea. Let's ignore this for now then.

Yes, we should add some comments. File an issue?

Filed issue #211.