Apply suggestions from code review

Co-authored-by: kirkrodrigues <[email protected]>
y-scope · Feb 4, 2025 · 202c4ee · 202c4ee
1 parent 1b1b290
commit 202c4ee
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp b/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp
@@ -5,7 +5,7 @@
 #include <fmt/core.h>
 
 #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
@@ -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;