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 no_tag_omission to allowedMacros #222

Closed sideshowbarker closed 7 years ago

sideshowbarker commented 7 years ago

The no_tag_omissionmacro is used in many HTML element pages.

SebastianZ commented 7 years ago

The change looks ok, even when the CI tests failed. Though while it may currently be used within HTML property tables, I am planning to remove the need for it in bug 1220137.

So, I'm wondering whether it should be added to the list of allowed macros. The same applies to many other macros currently used. They may be allowed for now, but they are expected to be removed.

We could instead add a note that tells the reason why a specific macro is not allowed and by what it should be replaced. In this case the message could be "The {{no_tag_omission}} macro can be used for now, but it is going to be removed in the future.", or to be very precise, "The {{no_tag_omission}} macro can be used for now, but it will removed once bug 1220137 is fixed.".

@Elchi3, what's your opinion about this? Should we add messages for them, should we allow them for now and disallow them in a later version of the add-on, or should we keep the add-on unchanged in this regard?

Sebastian

sideshowbarker commented 7 years ago

…while it may currently be used within HTML property tables, I am planning to remove the need for it in bug 1220137. So, I'm wondering whether it should be added to the list of allowed macros.

I’m personally fine with this PR not being merged, given that explanation.

"The {{no_tag_omission}} macro can be used for now, but it will removed once bug 1220137 is fixed.".

Yeah I think it would be helpful to add that in this case at least.

SebastianZ commented 7 years ago

…while it may currently be used within HTML property tables, I am planning to remove the need for it in bug 1220137. So, I'm wondering whether it should be added to the list of allowed macros.

I’m personally fine with this PR not being merged, given that explanation.

"The {{no_tag_omission}} macro can be used for now, but it will removed once bug 1220137 is fixed.".

Yeah I think it would be helpful to add that in this case at least.

Ok, so let's wait for @Elchi3's answer to decide what to do.

I wish you a Happy New Year 2017!

Sebastian

Elchi3 commented 7 years ago

Let's not fix this, I think the macro will go away indeed at some point.