[arrow-datafusion] branch main updated: Minor: improve docstrings on `SessionState` (#7654)

[alamb]

This is an automated email from the ASF dual-hosted git repository.

alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git


The following commit(s) were added to refs/heads/main by this push:
     new 3505b7f70c Minor: improve docstrings on `SessionState` (#7654)
3505b7f70c is described below

commit 3505b7f70cafcc15217c1a8659ee154a2167b225
Author: Andrew Lamb <and...@nerdnetworks.org>
AuthorDate: Mon Sep 25 16:22:33 2023 -0400

    Minor: improve docstrings on `SessionState` (#7654)
    
    * Minor: improve docstrings on `SessionState`
    
    * Update datafusion/core/src/execution/context.rs
    
    Co-authored-by: Liang-Chi Hsieh <vii...@gmail.com>
    
    ---------
    
    Co-authored-by: Liang-Chi Hsieh <vii...@gmail.com>
---
 datafusion/core/src/execution/context.rs | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/datafusion/core/src/execution/context.rs 
b/datafusion/core/src/execution/context.rs
index 78b79680b4..6cfb73a510 100644
--- a/datafusion/core/src/execution/context.rs
+++ b/datafusion/core/src/execution/context.rs
@@ -1348,7 +1348,12 @@ impl QueryPlanner for DefaultQueryPlanner {
     }
 }
 
-/// Execution context for registering data sources and executing queries
+/// Execution context for registering data sources and executing queries.
+/// See [`SessionContext`] for a higher level API.
+///
+/// Note that there is no `Default` or `new()` for SessionState,
+/// to avoid accidentally running queries or other operations without passing 
through
+/// the [`SessionConfig`] or [`RuntimeEnv`]. See [`SessionContext`].
 #[derive(Clone)]
 pub struct SessionState {
     /// A unique UUID that identifies the session