GitHub user vigneshsiva11 created a discussion: Guidelines for placing sync/async examples in docs vs standalone examples?
Hi folks, While working on parquet documentation, I noticed that ArrowReaderBuilder provides both synchronous and asynchronous variants. I was wondering if there are any preferred guidelines or conventions for when examples should live directly in rustdoc comments versus remaining as standalone examples under `parquet/examples`. For example: - Should async examples generally stay standalone? - Or is the preference to move commonly used patterns into API docs for better discoverability? I’d appreciate any guidance or pointers to existing conventions. Thanks! GitHub link: https://github.com/apache/arrow-rs/discussions/9168 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
