Incorrect reports of macro syntax errors for macros with JSON parameters

[a2sheppy]

See https://developer.mozilla.org/en-US/docs/Web/Guide/API for example. Its use of LandingPageListSubpagesPlus results in bogus errors.

[a2sheppy]

The horror of that JSON syntax is why I switched to macro-parsed strings for complex inputs like these. :)

[Elchi3]

In the past parameters were a big pain and lead to a very fragile system. They prevent us to refactor macros as we always need to update all pages that use parameters. Macros without parameters have been a best practice. Complex inputs (whether JSON or not) should be avoided at all.

[a2sheppy]

Hm... there are a lot of scenarios in which you can't leave out
parameters though.

---

From: Florian Scholz
Sent: Tuesday, Mar 29, 2016 7:20:49 AM EDT
To: Elchi3/mdn-doc-tests
Cc: Eric Shepherd
Subject: [Elchi3/mdn-doc-tests] Incorrect reports of macro syntax
errors for macros with JSON parameters (#139)

In the past parameters were a big pain and lead to a very fragile
system. They prevent us to refactor macros as we always need to update
all pages that use parameters. Macros without parameters have been a
best practice. Complex inputs (whether JSON or not) should be avoided
at all.

-- Sheppy

[SebastianZ]

Besides the discussion about whether macros with JSON input should be used or not, I agree that the recognition needs to be fixed on the MDN documentation tester side.

Parsing is a bit hard, though. The problem currently is to find the right closing curly bracket of the macro.
How does Kuma recognize the macros in this case?

Sebastian

[a2sheppy]

Sure, there are times where the macro can figure out what it needs to
do, but that doesn't seem like a very common use case to me. You
frequently need to pass in strings or data sets to be processed. But I
agree that we should try to avoid using parameters when we can do so.

That said, this bug is still a bug, even if we discourage complex input
parameters. :)

---

From: Florian Scholz
Sent: Tuesday, Mar 29, 2016 7:20:49 AM EDT
To: Elchi3/mdn-doc-tests
Cc: Eric Shepherd
Subject: [Elchi3/mdn-doc-tests] Incorrect reports of macro syntax
errors for macros with JSON parameters (#139)

In the past parameters were a big pain and lead to a very fragile
system. They prevent us to refactor macros as we always need to update
all pages that use parameters. Macros without parameters have been a
best practice. Complex inputs (whether JSON or not) should be avoided
at all.

—
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub
#139 (comment)

-- Sheppy