From 77273a676d4ed09e7c9191bbe51b68d2beee92b2 Mon Sep 17 00:00:00 2001 From: Evan Typanski Date: Wed, 18 Dec 2024 16:13:13 -0500 Subject: [PATCH] Document `get_tag` to ensure that `name` exists This caused confusion and I don't think it's very intuitive. If called with a name that does not exist, this returns without a value, not even an error value. Changing that seems like it could be more deprecation work. --- scripts/base/frameworks/analyzer/main.zeek | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/scripts/base/frameworks/analyzer/main.zeek b/scripts/base/frameworks/analyzer/main.zeek index 420d124bd8..dd911c2d3c 100644 --- a/scripts/base/frameworks/analyzer/main.zeek +++ b/scripts/base/frameworks/analyzer/main.zeek @@ -100,6 +100,10 @@ export { ## Translates an analyzer's name to a tag enum value. ## + ## The analyzer is assumed to exist; call + ## :zeek:see:`Analyzer::has_tag` first to verify that name is a + ## valid analyzer name. + ## ## name: The analyzer name. ## ## Returns: The analyzer tag corresponding to the name.