Fix debugging messages in the formatRenderedProblem method.
#2662
Conversation
drgrice1
force-pushed
the
bugfix/format-rendered-debug-messages
branch
from
1ab5a8d to
551001f
Compare
|
One way to test this is to get the MWE that @dlglin posted in #2661, and change line 399 of That also shows what would be needed to switch the PG problem editor to using the |
|
By the way, I don't think that anything ever sets the |
drgrice1
changed the title
formatRenderedProblem method.formatRenderedProblem method.
The `formatRenderedProblem` method of the `FormatRenderedProblem` module ensures that the `debug_messages` key of the rendered problem result is an array reference, but checks the wrong thing. It checks if the result itself is an array reference instead of the `debug_messages` hash key of the result. Since the result is always a hash reference and never an array reference, this means that the debugging messages from PG are always wiped out and replaced with a reference to an empty array. This was discovered when investigating openwebwork#2661. If we want to switch the PG problem editor to using the `debug` output format of the `formatRenderedProblem` method we could, but in order to get the benefit of that change we need this.
drgrice1
force-pushed
the
bugfix/format-rendered-debug-messages
branch
from
551001f to
313eb68
Compare
This is as discussed in openwebwork#2661, openwebwork#2662 and the developer meeting. The PG problem editor is switched to the debug format from the simple format. The only difference for the problem editor page is that if there are debug messages they are now shown. Usually there aren't any such messages, and so there isn't a difference. But if something is enabled like the MathObject diagnostics cmp flag, then those debug messages are shown.
The
formatRenderedProblemmethod of theFormatRenderedProblemmodule ensures that thedebug_messageskey of the rendered problem result is an array reference, but checks the wrong thing. It checks if the result itself is an array reference instead of thedebug_messageshash key of the result. Since the result is always a hash reference and never an array reference, this means that the debugging messages from PG are always wiped out and replaced with a reference to an empty array.This was discovered when investigating #2661. If we want to switch the PG problem editor to using the
debugoutput format of theformatRenderedProblemmethod we could, but in order to get the benefit of that change we need this.