consoleAdvisory

fun consoleAdvisory(logger: KLogger, message: () -> String)(source)

Emits a usability advisory. The message is always logged at WARN via the supplied logger and, unless consoleAdvisoriesOption is false, is also printed to standard output with a "KSL ADVISORY:" prefix.

This is the single sanctioned channel for console output in core library execution paths (outside explicit print/report APIs). It is intended for rare, mistake-preventing messages that must reach users who never look at log files, e.g. configurations that would cause a simulation to run forever.

Parameters

logger

the logger that records the advisory at WARN

message

the advisory message