Hi all,

I’m contributing to arrow-rs and recently worked on consolidating a parquet
example into the ArrowReaderBuilder documentation.

While doing so, I noticed that there are both synchronous and asynchronous
reader APIs available. I wanted to ask if there are any preferred guidelines
or conventions for when examples should live directly in rustdoc comments
versus remaining as standalone examples (for example under
parquet/examples).

In particular:
- Is there a general preference to keep async examples as standalone?
- Or should commonly used patterns (sync or async) be documented directly
  in API docs for better discoverability?

Any guidance or pointers to existing conventions would be appreciated.

Thanks,
Vignesh

Reply via email to