alamb commented on code in PR #11290:
URL: https://github.com/apache/datafusion/pull/11290#discussion_r1667067174
##########
docs/source/library-user-guide/using-the-dataframe-api.md:
##########
@@ -19,129 +19,236 @@
# Using the DataFrame API
-## What is a DataFrame
+## What is a DataFrame?
-`DataFrame` in `DataFrame` is modeled after the Pandas DataFrame interface,
and is a thin wrapper over LogicalPlan that adds functionality for building and
executing those plans.
-
-```rust
Review Comment:
I moved this example to the end as I think it makes more sense once you see
the DataFrame in action
##########
datafusion/core/src/lib.rs:
##########
@@ -635,5 +635,12 @@ doc_comment::doctest!(
#[cfg(doctest)]
doc_comment::doctest!(
"../../../docs/source/library-user-guide/using-the-sql-api.md",
- library_user_guide_example_usage
+ library_user_guide_sql_api
);
+
+#[cfg(doctest)]
+doc_comment::doctest!(
Review Comment:
This runs the examples as part of `cargo test --doc`
##########
docs/source/library-user-guide/using-the-sql-api.md:
##########
@@ -29,16 +29,15 @@ using the [`SessionContext::sql`] method. For lower level
control such as
preventing DDL, you can use [`SessionContext::sql_with_options`] or the
[`SessionState`] APIs
-[`sessioncontext`]:
https://docs.rs/datafusion/latest/datafusion/execution/context/struct.SessionContext.html
Review Comment:
I moved this down to the bottom of the doc so the links are't duplicated and
I could reuse `SessionContext::sql` reference
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
