This is an automated email from the ASF dual-hosted git repository.
wgtmac pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-cpp.git
The following commit(s) were added to refs/heads/main by this push:
new 8ec915e1 docs: fix public API comment mismatches (#1085)
8ec915e1 is described below
commit 8ec915e167ee453dfe9679d3572bfca70a9be6b1
Author: Sreesh Maheshwar <[email protected]>
AuthorDate: Thu Nov 5 08:51:14 2026 +0000
docs: fix public API comment mismatches (#1085)
---
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 16870539..c8b25185 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<Expression::Operation> OperationTypeFromJson(
const nlohmann::json& json);
diff --git a/src/iceberg/file_io.h b/src/iceberg/file_io.h
index 61e745a6..79faaacb 100644
--- a/src/iceberg/file_io.h
+++ b/src/iceberg/file_io.h
@@ -159,13 +159,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");
}
@@ -177,7 +177,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<std::string>& 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 e9c728dc..e65765bb 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 9245be02..f43d0649 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<std::optional<std::string_view>> FindColumnNameById(int32_t field_id)
const;
