@@ -59,22 +59,28 @@ class ICEBERG_EXPORT Schema : public StructType {
5959
6060 std::string ToString () const override ;
6161
62- // / \brief Recursively Find the SchemaField by field name.
62+ // / \brief Recursively find the SchemaField by field name.
6363 // /
6464 // / Short names for maps and lists are included for any name that does not conflict with
6565 // / a canonical name. For example, a list, 'l', of structs with field 'x' will produce
66- // / short name 'l.x' in addition to canonical name 'l.element.x'.
66+ // / short name 'l.x' in addition to canonical name 'l.element.x'. A map 'm', if its
67+ // / value include a structs with field 'x' wil produce short name 'm.x' in addition to
68+ // / canonical name 'm.value.x'.
6769 // / FIXME: Currently only handles ASCII lowercase conversion; extend to support
6870 // / non-ASCII characters (e.g., using std::towlower or ICU)
6971 Result<std::optional<std::reference_wrapper<const SchemaField>>> FindFieldByName (
7072 std::string_view name, bool case_sensitive = true ) const ;
7173
72- // / \brief Recursively Find the SchemaField by field id.
74+ // / \brief Recursively find the SchemaField by field id.
75+ // /
76+ // / \param field_id The id of the field to get the accessor for.
77+ // / \return The field with the given id, or std::nullopt if not found.
7378 Result<std::optional<std::reference_wrapper<const SchemaField>>> FindFieldById (
7479 int32_t field_id) const ;
7580
7681 // / \brief Get the accessor to access the field by field id.
7782 // /
83+ // / \param field_id The id of the field to get the accessor for.
7884 // / \return The accessor to access the field, or NotFound if the field is not found.
7985 Result<std::unique_ptr<StructLikeAccessor>> GetAccessorById (int32_t field_id) const ;
8086
0 commit comments