Skip to content

Commit 2fcab2e

Browse files
authored
Improve SessionStateBuilder::new documentation (#14980)
1 parent ea1ca27 commit 2fcab2e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

datafusion/core/src/execution/session_state.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,7 +1012,10 @@ pub struct SessionStateBuilder {
10121012
}
10131013

10141014
impl SessionStateBuilder {
1015-
/// Returns a new [`SessionStateBuilder`] with no options set.
1015+
/// Returns a new empty [`SessionStateBuilder`].
1016+
///
1017+
/// See [`Self::with_default_features`] to install the default set of functions,
1018+
/// catalogs, etc.
10161019
pub fn new() -> Self {
10171020
Self {
10181021
session_id: None,
@@ -1042,9 +1045,10 @@ impl SessionStateBuilder {
10421045
}
10431046
}
10441047

1045-
/// Returns a new [SessionStateBuilder] based on an existing [SessionState]
1048+
/// Returns a new [SessionStateBuilder] based on an existing [SessionState].
1049+
///
10461050
/// The session id for the new builder will be unset; all other fields will
1047-
/// be cloned from what is set in the provided session state. If the default
1051+
/// be cloned from `existing`. If the default
10481052
/// catalog exists in existing session state, the new session state will not
10491053
/// create default catalog and schema.
10501054
pub fn new_from_existing(existing: SessionState) -> Self {

0 commit comments

Comments
 (0)