Update components/core/src/clp/ffi/ir_stream/Serializer.hpp

Co-authored-by: kirkrodrigues <[email protected]>
y-scope · Jan 24, 2025 · 5942e4d · 5942e4d
1 parent a809436
commit 5942e4d
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/components/core/src/clp/ffi/ir_stream/Serializer.hpp b/components/core/src/clp/ffi/ir_stream/Serializer.hpp
@@ -44,7 +44,7 @@ class Serializer {
      * @param optional_user_defined_metadata Stream-level user-defined metadata, given as a JSON
      * object.
      * @return A result containing the serializer or an error code indicating the failure:
-     * - std::errc::protocol_error if failed to serialize the preamble.
+     * - std::errc::protocol_error if the stream's metadata couldn't be serialized.
      * - std::errc::protocol_not_supported if the given user-defined metadata is not a JSON object.
      */
     [[nodiscard]] static auto create(