emilk opened a new pull request, #50826: URL: https://github.com/apache/arrow/pull/50826
### Rationale for this change `flatc` only propagates `///` comments into generated bindings. A few descriptions in `Message.fbs` and `Schema.fbs` use plain `//`, so they are silently dropped and never reach downstream users. For example `CompressionType::LZ4_FRAME` has a helpful note about frame vs. raw/block format that does not appear in the generated Rust in arrow-rs. The `custom_metadata` field is documented on `Field` and `Footer` (both `///`) but not on `Schema` (`//`). ### What changes are included in this PR? Changed `//` to `///` for five comment blocks that describe a declaration: | File | Declaration | |-------------|--------------------------------| | Message.fbs | `CompressionType.LZ4_FRAME` | | Message.fbs | `CompressionType.ZSTD` | | Schema.fbs | `IntervalUnit` | | Schema.fbs | `Duration` | | Schema.fbs | `Schema.custom_metadata` | The `IntervalUnit` block sat *after* the enum, so `///` in place would have attached it to `table Interval` instead. It is moved above `enum IntervalUnit`, which is what it describes. Comments only. No schema, wire format, or field numbering changes. ### Are these changes tested? Generated Rust with `flatc 23.5.26` before and after and diffed. The only differences are the five added doc comment blocks. ### Are there any user-facing changes? Yes, in the good sense: these descriptions now show up in generated bindings for all languages. --- Disclosure per the [AI-generated code guidance](https://arrow.apache.org/docs/dev/developers/overview.html#ai-generated-code): I used Claude Code to find the affected comments and verify the generated-output diff. I reviewed every line. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
