From 202c4ee7189ec818eae4e90c843dd0b5139e016e Mon Sep 17 00:00:00 2001 From: davemarco <83603688+davemarco@users.noreply.github.com> Date: Tue, 4 Feb 2025 11:51:09 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> --- .../core/src/clp/streaming_archive/ArchiveMetadata.cpp | 2 +- .../core/src/clp/streaming_archive/ArchiveMetadata.hpp | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp b/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp index 8f0941b03..4527bcc87 100644 --- a/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp +++ b/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp @@ -5,7 +5,7 @@ #include #include "../Array.hpp" -#include "FileReader.hpp" +#include "../FileReader.hpp" namespace clp::streaming_archive { ArchiveMetadata::ArchiveMetadata( diff --git a/components/core/src/clp/streaming_archive/ArchiveMetadata.hpp b/components/core/src/clp/streaming_archive/ArchiveMetadata.hpp index 31f75f597..44f3c47c9 100644 --- a/components/core/src/clp/streaming_archive/ArchiveMetadata.hpp +++ b/components/core/src/clp/streaming_archive/ArchiveMetadata.hpp @@ -11,7 +11,6 @@ #include "Constants.hpp" namespace clp::streaming_archive { - /** * A class to encapsulate metadata directly relating to an archive. */ @@ -54,9 +53,10 @@ class ArchiveMetadata { * * @param file_path * @return The created instance. - * @throw `ArchiveMetadata::OperationFailed` if stat or read operation on metadata file fails. - * @throw `msgpack::unpack_error` if data cannot be unpacked into MessagePack object. - * @throw `msgpack::type_error` if MessagePack object can't be converted to `ArchiveMetadata`. + * @throw `ArchiveMetadata::OperationFailed` if `stat` fails or the file couldn't be read. + * @throw `msgpack::unpack_error` if the data cannot be unpacked into a MessagePack object. + * @throw `msgpack::type_error` if the MessagePack object can't be converted to an + * `ArchiveMetadata` instance. */ [[nodiscard]] static auto create_from_file(std::string_view file_path) -> ArchiveMetadata;