Skip to content

Commit fab1da2

Browse files
committed
docs: change Return to Returns in Table API comments
1 parent e7e7e11 commit fab1da2

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

src/iceberg/table.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,49 +50,49 @@ class ICEBERG_EXPORT Table : public std::enable_shared_from_this<Table> {
5050

5151
virtual ~Table();
5252

53-
/// \brief Return the identifier of this table
53+
/// \brief Returns the identifier of this table
5454
const TableIdentifier& name() const { return identifier_; }
5555

5656
/// \brief Returns the UUID of the table
5757
const std::string& uuid() const;
5858

59-
/// \brief Return the schema for this table, return NotFoundError if not found
59+
/// \brief Returns the schema for this table, return NotFoundError if not found
6060
Result<std::shared_ptr<Schema>> schema() const;
6161

62-
/// \brief Return a map of schema for this table
62+
/// \brief Returns a map of schema for this table
6363
Result<
6464
std::reference_wrapper<const std::unordered_map<int32_t, std::shared_ptr<Schema>>>>
6565
schemas() const;
6666

67-
/// \brief Return the partition spec for this table, return NotFoundError if not found
67+
/// \brief Returns the partition spec for this table, return NotFoundError if not found
6868
Result<std::shared_ptr<PartitionSpec>> spec() const;
6969

70-
/// \brief Return a map of partition specs for this table
70+
/// \brief Returns a map of partition specs for this table
7171
Result<std::reference_wrapper<
7272
const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>>>
7373
specs() const;
7474

75-
/// \brief Return the sort order for this table, return NotFoundError if not found
75+
/// \brief Returns the sort order for this table, return NotFoundError if not found
7676
Result<std::shared_ptr<SortOrder>> sort_order() const;
7777

78-
/// \brief Return a map of sort order IDs to sort orders for this table
78+
/// \brief Returns a map of sort order IDs to sort orders for this table
7979
Result<std::reference_wrapper<
8080
const std::unordered_map<int32_t, std::shared_ptr<SortOrder>>>>
8181
sort_orders() const;
8282

83-
/// \brief Return a map of string properties for this table
83+
/// \brief Returns a map of string properties for this table
8484
const TableProperties& properties() const;
8585

86-
/// \brief Return the table's metadata file location
86+
/// \brief Returns the table's metadata file location
8787
std::string_view metadata_file_location() const;
8888

89-
/// \brief Return the table's base location
89+
/// \brief Returns the table's base location
9090
std::string_view location() const;
9191

9292
/// \brief Returns the time when this table was last updated
9393
TimePointMs last_updated_ms() const;
9494

95-
/// \brief Return the table's current snapshot, return NotFoundError if not found
95+
/// \brief Returns the table's current snapshot, return NotFoundError if not found
9696
Result<std::shared_ptr<Snapshot>> current_snapshot() const;
9797

9898
/// \brief Get the snapshot of this table with the given id
@@ -116,7 +116,7 @@ class ICEBERG_EXPORT Table : public std::enable_shared_from_this<Table> {
116116
/// \brief Returns the catalog that this table belongs to
117117
const std::shared_ptr<Catalog>& catalog() const;
118118

119-
/// \brief Return a LocationProvider for this table
119+
/// \brief Returns a LocationProvider for this table
120120
Result<std::unique_ptr<LocationProvider>> location_provider() const;
121121

122122
/// \brief Refresh the current table metadata

0 commit comments

Comments
 (0)