From a59071fde7b1974c91450f0b45e4902b3f04717c Mon Sep 17 00:00:00 2001 From: Sreesh Maheshwar Date: Sun, 6 Sep 2026 23:01:39 +0100 Subject: [PATCH] docs: fix public API comment mismatches --- src/iceberg/expression/json_serde_internal.h | 2 +- src/iceberg/file_io.h | 6 +++--- src/iceberg/partition_spec.h | 2 +- src/iceberg/schema.h | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/iceberg/expression/json_serde_internal.h b/src/iceberg/expression/json_serde_internal.h index 168705399..c8b25185e 100644 --- a/src/iceberg/expression/json_serde_internal.h +++ b/src/iceberg/expression/json_serde_internal.h @@ -33,7 +33,7 @@ namespace iceberg { /// \brief Converts an operation type string to an Expression::Operation. /// -/// \param typeStr The operation type string +/// \param json The JSON value containing the operation type string /// \return The corresponding Operation or an error if unknown ICEBERG_EXPORT Result OperationTypeFromJson( const nlohmann::json& json); diff --git a/src/iceberg/file_io.h b/src/iceberg/file_io.h index 3ea4afa49..53145f567 100644 --- a/src/iceberg/file_io.h +++ b/src/iceberg/file_io.h @@ -157,13 +157,13 @@ class ICEBERG_EXPORT FileIO { /// /// \param file_location The location of the file to write. /// \param content The content to write to the file. - /// \return void if the write succeeded, an error code if the write failed. + /// \return Status indicating success, or an error if the write failed. virtual Status WriteFile(const std::string& file_location, std::string_view content); /// \brief Delete a file at the given location. /// /// \param file_location The location of the file to delete. - /// \return void if the delete succeeded, an error code if the delete failed. + /// \return Status indicating success, or an error if the delete failed. virtual Status DeleteFile(const std::string& file_location) { return NotImplemented("DeleteFile not implemented"); } @@ -175,7 +175,7 @@ class ICEBERG_EXPORT FileIO { /// and returns the first error encountered. /// /// \param file_locations The locations of the files to delete. - /// \return void if all deletes succeed, or an error code if any delete fails. + /// \return Status indicating success, or an error if any delete fails. virtual Status DeleteFiles(const std::vector& file_locations); /// \brief Return storage-credential support when implemented by this FileIO. diff --git a/src/iceberg/partition_spec.h b/src/iceberg/partition_spec.h index e9c728dc0..e65765bb8 100644 --- a/src/iceberg/partition_spec.h +++ b/src/iceberg/partition_spec.h @@ -108,7 +108,7 @@ class ICEBERG_EXPORT PartitionSpec : public util::Formattable { /// \param schema The schema to bind the partition spec to. /// \param spec_id The spec ID. /// \param fields The partition fields. - /// \param allowMissingFields Whether to skip validation for partition fields whose + /// \param allow_missing_fields Whether to skip validation for partition fields whose /// source columns have been dropped from the schema. /// \param last_assigned_field_id The last assigned field ID assigned to ensure new /// fields get unique IDs. diff --git a/src/iceberg/schema.h b/src/iceberg/schema.h index 9245be02e..f43d06493 100644 --- a/src/iceberg/schema.h +++ b/src/iceberg/schema.h @@ -146,7 +146,7 @@ class ICEBERG_EXPORT Schema : public StructType { /// \brief Returns the canonical field name for the given id. /// /// \param field_id The id of the field to get the canonical name for. - /// \return The canocinal column name of the field with the given id, or std::nullopt if + /// \return The canonical column name of the field with the given id, or std::nullopt if /// not found. Result> FindColumnNameById(int32_t field_id) const;