docstr updated for use_docker in execute_code (#233)

* docstr updated

* fixed line 245

* Fixed line 246

* space_traling error Fix_01

* Revert space in '-'

* Fixed line 245 FIX_02

---------

Co-authored-by: Qingyun Wu <qingyun.wu@psu.edu>
This commit is contained in:
Gourav
2023-10-16 09:45:03 +05:30
committed by GitHub
parent 1394e29326
commit ea8dec7ea9

View File

@@ -242,7 +242,11 @@ def execute_code(
If a list or a str of image name(s) is provided, the code will be executed in a docker container
with the first image successfully pulled.
If None, False or empty, the code will be executed in the current environment.
Default is True, which will be converted into a list.
Default is None, which will be converted into an empty list when docker package is available.
Expected behaviour:
- If `use_docker` is explicitly set to True and the docker package is available, the code will run in a Docker container.
- If `use_docker` is explicitly set to True but the Docker package is missing, an error will be raised.
- If `use_docker` is not set (i.e., left default to None) and the Docker package is not available, a warning will be displayed, but the code will run natively.
If the code is executed in the current environment,
the code must be trusted.
lang (Optional, str): The language of the code. Default is "python".