Skip to content

Commit 30b2543

Browse files
committed
Move example to doctestable examples for context.py
1 parent 85a3595 commit 30b2543

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

python/datafusion/context.py

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -371,9 +371,8 @@ def with_fair_spill_pool(self, size: int) -> RuntimeEnvBuilder:
371371
Returns:
372372
A new :py:class:`RuntimeEnvBuilder` object with the updated setting.
373373
374-
Examples usage::
375-
376-
config = RuntimeEnvBuilder().with_fair_spill_pool(1024)
374+
Examples:
375+
>>> config = dfn.RuntimeEnvBuilder().with_fair_spill_pool(1024)
377376
"""
378377
self.config_internal = self.config_internal.with_fair_spill_pool(size)
379378
return self
@@ -391,9 +390,8 @@ def with_greedy_memory_pool(self, size: int) -> RuntimeEnvBuilder:
391390
Returns:
392391
A new :py:class:`RuntimeEnvBuilder` object with the updated setting.
393392
394-
Example usage::
395-
396-
config = RuntimeEnvBuilder().with_greedy_memory_pool(1024)
393+
Examples:
394+
>>> config = dfn.RuntimeEnvBuilder().with_greedy_memory_pool(1024)
397395
"""
398396
self.config_internal = self.config_internal.with_greedy_memory_pool(size)
399397
return self
@@ -407,9 +405,8 @@ def with_temp_file_path(self, path: str | pathlib.Path) -> RuntimeEnvBuilder:
407405
Returns:
408406
A new :py:class:`RuntimeEnvBuilder` object with the updated setting.
409407
410-
Example usage::
411-
412-
config = RuntimeEnvBuilder().with_temp_file_path("/tmp")
408+
Examples:
409+
>>> config = dfn.RuntimeEnvBuilder().with_temp_file_path("/tmp")
413410
"""
414411
self.config_internal = self.config_internal.with_temp_file_path(str(path))
415412
return self
@@ -444,9 +441,8 @@ def with_allow_ddl(self, allow: bool = True) -> SQLOptions:
444441
Returns:
445442
A new :py:class:`SQLOptions` object with the updated setting.
446443
447-
Example usage::
448-
449-
options = SQLOptions().with_allow_ddl(True)
444+
Examples:
445+
>>> options = dfn.SQLOptions().with_allow_ddl(True)
450446
"""
451447
self.options_internal = self.options_internal.with_allow_ddl(allow)
452448
return self
@@ -462,9 +458,8 @@ def with_allow_dml(self, allow: bool = True) -> SQLOptions:
462458
Returns:
463459
A new :py:class:`SQLOptions` object with the updated setting.
464460
465-
Example usage::
466-
467-
options = SQLOptions().with_allow_dml(True)
461+
Examples:
462+
>>> options = dfn.SQLOptions().with_allow_dml(True)
468463
"""
469464
self.options_internal = self.options_internal.with_allow_dml(allow)
470465
return self
@@ -478,9 +473,8 @@ def with_allow_statements(self, allow: bool = True) -> SQLOptions:
478473
Returns:
479474
A new :py:class:SQLOptions` object with the updated setting.
480475
481-
Example usage::
482-
483-
options = SQLOptions().with_allow_statements(True)
476+
Examples:
477+
>>> options = dfn.SQLOptions().with_allow_statements(True)
484478
"""
485479
self.options_internal = self.options_internal.with_allow_statements(allow)
486480
return self

0 commit comments

Comments
 (0)