Merge remote-tracking branch 'smoot/topic/smoot/reporter'

* smoot/topic/smoot/reporter: Update reporter.bif.zeek.rst to describe special case of errors in init
zeek · Apr 26, 2024 · 80d0c34 · 80d0c34
2 parents 638aede + 3b6f8eb
commit 80d0c34
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/scripts/base/bif/reporter.bif.zeek.rst b/scripts/base/bif/reporter.bif.zeek.rst
@@ -22,8 +22,8 @@ Functions
 #########
 ========================================================================== ========================================================================
 :zeek:id:`Reporter::conn_weird`: :zeek:type:`function`                     Generates a "conn" weird.
-:zeek:id:`Reporter::error`: :zeek:type:`function`                          Generates a non-fatal error indicative of a definite problem that should
-                                                                           be addressed.
+:zeek:id:`Reporter::error`: :zeek:type:`function`                          Generates a usually non-fatal error indicative of a definite problem that 
+                                                                           should be addressed.
 :zeek:id:`Reporter::fatal`: :zeek:type:`function`                          Generates a fatal error on stderr and terminates program execution.
 :zeek:id:`Reporter::fatal_error_with_core`: :zeek:type:`function`          Generates a fatal error on stderr and terminates program execution
                                                                            after dumping a core file
@@ -74,7 +74,8 @@ Functions
    :Type: :zeek:type:`function` (msg: :zeek:type:`string`) : :zeek:type:`bool`
 
    Generates a non-fatal error indicative of a definite problem that should
-   be addressed. Program execution does not terminate.
+   be addressed. Program execution does not terminate unless the error is
+   reported during initialization (e.g., :zeek:see:`zeek_init`).
 
 
    :param msg: The error message to report.