From 9b31d8aa0ea81883189054de3fccfe5b36933b72 Mon Sep 17 00:00:00 2001 From: TheTechromancer Date: Fri, 22 Sep 2023 16:36:12 -0400 Subject: [PATCH] updated internal method docstring --- bbot/core/event/base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bbot/core/event/base.py b/bbot/core/event/base.py index e06d27fec0..a878a9344d 100644 --- a/bbot/core/event/base.py +++ b/bbot/core/event/base.py @@ -379,8 +379,8 @@ def _json_data_key(self): Because self.data can be either a string or a dictionary, this function is used to standardize JSON-serialized events so that their .data attributes are _always_ dictionaries. - By default, simple string-based events like `IP_ADDRESS`, `DNS_NAME`, and `URL` are serialized - so that their event type is the sole key, and their data is the value. + Events are serialized so that at the top level of their .data object there is a single + key which is their event type, and their data is the value. For example, an `IP_ADDRESS` with .data of `"192.168.0.1"' will be `{"IP_ADDRESS": "192.168.0.1"}`. A `DNS_NAME` of `evilcorp.com` will be `{"DNS_NAME": "evilcorp.com"}`, etc.