From 09d2db0a8baf8d28cc8a6ca06ff091e60a4fabaa Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Sat, 23 Nov 2024 20:26:12 -0500 Subject: [PATCH] Fix comment --- components/core/src/clp/ffi/KeyValuePairLogEvent.hpp | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/components/core/src/clp/ffi/KeyValuePairLogEvent.hpp b/components/core/src/clp/ffi/KeyValuePairLogEvent.hpp index 007f155bb..754750f05 100644 --- a/components/core/src/clp/ffi/KeyValuePairLogEvent.hpp +++ b/components/core/src/clp/ffi/KeyValuePairLogEvent.hpp @@ -104,10 +104,12 @@ class KeyValuePairLogEvent { /** * Serializes the log event into `nlohmann::json` objects. - * @return A result containing a pair of serialized JSON objects (the first contains - * auto-generated key-value pairs, while the second contains user-generated key-value pairs), or - * an error code indicating the failure: - * - Forwards `serialize_node_id_value_pairs_to_json`'s return values. + * @return A result containing a pair or an error code indicating the failure: + * - The pair: + * - Serialized auto-generated key-value pairs as a JSON object + * - Serialized user-generated key-value pairs as a JSON object + * - The possible error codes: + * - Forwards `serialize_node_id_value_pairs_to_json`'s return values on failure. */ [[nodiscard]] auto serialize_to_json( ) const -> OUTCOME_V2_NAMESPACE::std_result>;