Small adjustment to documentation

timsaucer · timsaucer · commit bf626f492c75 · 2024-10-29T20:21:27.000-04:00
diff --git a/datafusion/ffi/src/session_config.rs b/datafusion/ffi/src/session_config.rs
@@ -144,7 +144,10 @@ impl Drop for FFI_SessionConfig {
     }
 }
 
-/// A wrapper struct for accessing [`SessionConfig`] across a FFI boundary
+/// A wrapper struct for accessing [`SessionConfig`] across a FFI boundary.
+/// The [`SessionConfig`] will be generated from a hash map of the config
+/// options in the provider and will be reconstructed on this side of the
+/// interface.s
 pub struct ForeignSessionConfig(pub SessionConfig);
 
 impl TryFrom<&FFI_SessionConfig> for ForeignSessionConfig {

Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,10 @@ impl Drop for FFI_SessionConfig {`
`144`	`144`	`}`
`145`	`145`	`}`
`146`	`146`
`147`		-/// A wrapper struct for accessing [`SessionConfig`] across a FFI boundary
	`147`	+/// A wrapper struct for accessing [`SessionConfig`] across a FFI boundary.
	`148`	+/// The [`SessionConfig`] will be generated from a hash map of the config
	`149`	`+/// options in the provider and will be reconstructed on this side of the`
	`150`	`+/// interface.s`
`148`	`151`	`pub struct ForeignSessionConfig(pub SessionConfig);`
`149`	`152`
`150`	`153`	`impl TryFrom<&FFI_SessionConfig> for ForeignSessionConfig {`