Skip to content

Commit 886dae3

Browse files
committed
fix: cleanup doc comments
1 parent 32eb007 commit 886dae3

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ tpchgen = "1.0.0"
1010
tpchgen-arrow = "1.0.0"
1111

1212
[dev-dependencies]
13-
tokio = "1.44.2"
13+
tokio = { version = "1.44.2", features = ["rt-multi-thread", "macros"] }

src/lib.rs

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ use tpchgen_arrow::RecordBatchIterator;
1212
macro_rules! define_tpch_udtf_provider {
1313
($TABLE_FUNCTION_NAME:ident, $TABLE_FUNCTION_SQL_NAME:ident, $GENERATOR:ty, $ARROW_GENERATOR:ty) => {
1414
#[doc = concat!(
15-
"A table function that generates the `",
16-
stringify!($TABLE_FUNCTION_SQL_NAME),
17-
"` table using the `tpchgen` library."
18-
)]
15+
"A table function that generates the `",
16+
stringify!($TABLE_FUNCTION_SQL_NAME),
17+
"` table using the `tpchgen` library."
18+
)]
1919
///
2020
/// The expected arguments are a float literal for the scale factor,
2121
/// an i64 literal for the part, and an i64 literal for the number of parts.
@@ -24,11 +24,16 @@ macro_rules! define_tpch_udtf_provider {
2424
///
2525
/// # Examples
2626
/// ```
27+
/// use std::sync::Arc;
28+
/// use std::io::Error;
29+
///
30+
/// use datafusion::prelude::*;
31+
/// use datafusion_tpch::*;
32+
///
2733
/// #[tokio::main]
28-
/// async fn main() -> Result<()> {
34+
/// async fn main() -> Result<(), Error> {
2935
/// // create local execution context
3036
/// let ctx = SessionContext::new();
31-
3237
/// // Register all the UDTFs.
3338
/// ctx.register_udtf(TpchNation::name(), Arc::new(TpchNation {}));
3439
/// ctx.register_udtf(TpchCustomer::name(), Arc::new(TpchCustomer {}));

0 commit comments

Comments
 (0)