At first I thought this was a bug: I saw that doc.internal.errors must have gotten populated with an error but I figured that whatever caused this was silent when it was supposed to have given a message. I now suspect that actually, whatever populated doc.internal.errors was in one of the warning messages.
This is pretty confusing, it conflates the meaning of WARN and ERROR. The log up until it terminates would seem to indicate that nothing irreparable is occurring, and I should expect the process to complete. The "terminating build" error then leaves me wondering what actually happened. In my case, build was created and seems correct, but I don't know what the behavior of this is supposed to be in general.
I suggest one of the following alternatives:
Show an @error log message for anything that populates doc.internal.errors.
Keep the current @warn behavior, but make the error mesage on this line much clearer: indicate what has caused the error and whether or not the user can expect the docs to have built successfully. Perhaps it would be appropriate (perhaps depending on context) to change the explicit error throw itself to a warning.
I encountered the following when trying to build some docs
At first I thought this was a bug: I saw that
doc.internal.errors
must have gotten populated with an error but I figured that whatever caused this was silent when it was supposed to have given a message. I now suspect that actually, whatever populateddoc.internal.errors
was in one of the warning messages.This is pretty confusing, it conflates the meaning of
WARN
andERROR
. The log up until it terminates would seem to indicate that nothing irreparable is occurring, and I should expect the process to complete. The "terminating build" error then leaves me wondering what actually happened. In my case,build
was created and seems correct, but I don't know what the behavior of this is supposed to be in general.I suggest one of the following alternatives:
@error
log message for anything that populatesdoc.internal.errors
.@warn
behavior, but make theerror
mesage on this line much clearer: indicate what has caused the error and whether or not the user can expect the docs to have built successfully. Perhaps it would be appropriate (perhaps depending on context) to change the expliciterror
throw itself to a warning.