crepererum opened a new issue, #16654: URL: https://github.com/apache/datafusion/issues/16654
# What It's hard to put in words, but have a look at this example from `bevy`: https://docs.rs/bevy/0.16.1/bevy/prelude/struct.Events.html#method.send  Also see [this explanation](https://docs.rs/bevy/0.16.1/scrape-examples-help.html). # Why I think the "manual style" of adding some code to the doc string is very good, e.g.: ```rust /// Get value for given key.\ /// /// # Example /// ``` /// ... /// ``` pub fn get(&self, k: &str) -> Option<...> { ... ``` However sometimes it helps to see certain methods used in a wider context or more complex examples. While one can manually link examples, I think the rendering of `rustdoc` is great and avoiding manual maintenance burden is always a plus. I think this greatly helps people to understand what certain methods do. # How IIRC [docs.rs](https://docs.rs/) uses a nightly compiler. So all we would need to do is to [follow `bevy`](https://github.com/bevyengine/bevy/blob/1a410efd246e0f2f41766d47e300f474c8379b2e/Cargo.toml#L4357). -- 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: github-unsubscr...@datafusion.apache.org.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
