Skip to content

Commit 04ab998

Browse files
committed
Update help text and docstrings for env_managment args
1 parent 4a43eae commit 04ab998

File tree

3 files changed

+127
-120
lines changed

3 files changed

+127
-120
lines changed

rsconnect/actions.py

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -540,10 +540,10 @@ def write_quarto_manifest_json(
540540
:param extra_files: Any extra files to include in the manifest.
541541
:param excludes: A sequence of glob patterns to exclude when enumerating files to bundle.
542542
:param image: the optional docker image to be specified for off-host execution. Default = None.
543-
:param env_management_py: False indicates that the user is responsible for Python package installation
544-
in the runtime environment. Default = None.
545-
:param env_management_r: False indicates that the user is responsible for R package installation
546-
in the runtime environment. Default = None.
543+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
544+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
545+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
546+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
547547
"""
548548
warn("This method has been moved and will be deprecated.", DeprecationWarning, stacklevel=2)
549549

@@ -661,10 +661,10 @@ def deploy_jupyter_notebook(
661661
:param hide_tagged_input: If True, will hide input code cells with the 'hide_input' tag when rendering
662662
output. Previous default = False.
663663
:param image: the optional docker image to be specified for off-host execution. Default = None.
664-
:param env_management_py: False indicates that the user is responsible for Python package installation
665-
in the runtime environment. Default = None.
666-
:param env_management_r: False indicates that the user is responsible for R package installation
667-
in the runtime environment. Default = None.
664+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
665+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
666+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
667+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
668668
:return: the ultimate URL where the deployed app may be accessed and the sequence
669669
of log lines. The log lines value will be None if a log callback was provided.
670670
"""
@@ -867,10 +867,10 @@ def deploy_python_api(
867867
If a log callback is provided, then None will be returned for the log lines part
868868
of the return tuple. Previous default = None.
869869
:param image: the optional docker image to be specified for off-host execution. Default = None.
870-
:param env_management_py: False indicates that the user is responsible for Python package installation
871-
in the runtime environment. Default = None.
872-
:param env_management_r: False indicates that the user is responsible for R package installation
873-
in the runtime environment. Default = None.
870+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
871+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
872+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
873+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
874874
:return: the ultimate URL where the deployed app may be accessed and the sequence
875875
of log lines. The log lines value will be None if a log callback was provided.
876876
"""
@@ -917,10 +917,10 @@ def deploy_python_fastapi(
917917
If a log callback is provided, then None will be returned for the log lines part
918918
of the return tuple. Previous default = None.
919919
:param image: the optional docker image to be specified for off-host execution. Default = None.
920-
:param env_management_py: False indicates that the user is responsible for Python package installation
921-
in the runtime environment. Default = None.
922-
:param env_management_r: False indicates that the user is responsible for R package installation
923-
in the runtime environment. Default = None.
920+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
921+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
922+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
923+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
924924
:return: the ultimate URL where the deployed app may be accessed and the sequence
925925
of log lines. The log lines value will be None if a log callback was provided.
926926
"""
@@ -1009,10 +1009,10 @@ def deploy_dash_app(
10091009
If a log callback is provided, then None will be returned for the log lines part
10101010
of the return tuple. Previous default = None.
10111011
:param image: the optional docker image to be specified for off-host execution. Default = None.
1012-
:param env_management_py: False indicates that the user is responsible for Python package installation
1013-
in the runtime environment. Default = None.
1014-
:param env_management_r: False indicates that the user is responsible for R package installation
1015-
in the runtime environment. Default = None.
1012+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1013+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1014+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1015+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
10161016
:return: the ultimate URL where the deployed app may be accessed and the sequence
10171017
of log lines. The log lines value will be None if a log callback was provided.
10181018
"""
@@ -1059,10 +1059,10 @@ def deploy_streamlit_app(
10591059
If a log callback is provided, then None will be returned for the log lines part
10601060
of the return tuple. Previous default = None.
10611061
:param image: the optional docker image to be specified for off-host execution. Default = None.
1062-
:param env_management_py: False indicates that the user is responsible for Python package installation
1063-
in the runtime environment. Default = None.
1064-
:param env_management_r: False indicates that the user is responsible for R package installation
1065-
in the runtime environment. Default = None.
1062+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1063+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1064+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1065+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
10661066
:return: the ultimate URL where the deployed app may be accessed and the sequence
10671067
of log lines. The log lines value will be None if a log callback was provided.
10681068
"""
@@ -1109,10 +1109,10 @@ def deploy_bokeh_app(
11091109
If a log callback is provided, then None will be returned for the log lines part
11101110
of the return tuple. Previous default = None.
11111111
:param image: the optional docker image to be specified for off-host execution. Default = None.
1112-
:param env_management_py: False indicates that the user is responsible for Python package installation
1113-
in the runtime environment. Default = None.
1114-
:param env_management_r: False indicates that the user is responsible for R package installation
1115-
in the runtime environment. Default = None.
1112+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1113+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1114+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1115+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
11161116
:return: the ultimate URL where the deployed app may be accessed and the sequence
11171117
of log lines. The log lines value will be None if a log callback was provided.
11181118
"""
@@ -1215,10 +1215,10 @@ def create_notebook_deployment_bundle(
12151215
:param hide_tagged_input: If True, will hide input code cells with
12161216
the 'hide_input' tag when rendering output. Previous default = False.
12171217
:param image: the optional docker image to be specified for off-host execution. Default = None.
1218-
:param env_management_py: False indicates that the user is responsible for Python package installation
1219-
in the runtime environment. Default = None.
1220-
:param env_management_r: False indicates that the user is responsible for R package installation
1221-
in the runtime environment. Default = None.
1218+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1219+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1220+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1221+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
12221222
12231223
:return: the bundle.
12241224
"""
@@ -1281,10 +1281,10 @@ def create_api_deployment_bundle(
12811281
with the specified directory. If you provide False here, make sure the names
12821282
are properly qualified first. Previous default = True.
12831283
:param image: the optional docker image to be specified for off-host execution. Default = None.
1284-
:param env_management_py: False indicates that the user is responsible for Python package installation
1285-
in the runtime environment. Default = None.
1286-
:param env_management_r: False indicates that the user is responsible for R package installation
1287-
in the runtime environment. Default = None.
1284+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1285+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1286+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1287+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
12881288
:return: the bundle.
12891289
"""
12901290
entry_point = validate_entry_point(entry_point, directory)
@@ -1324,10 +1324,10 @@ def create_quarto_deployment_bundle(
13241324
with the specified directory. If you provide False here, make sure the names
13251325
are properly qualified first. Previous default = True.
13261326
:param image: the optional docker image to be specified for off-host execution. Default = None.
1327-
:param env_management_py: False indicates that the user is responsible for Python package installation
1328-
in the runtime environment. Default = None.
1329-
:param env_management_r: False indicates that the user is responsible for R package installation
1330-
in the runtime environment. Default = None.
1327+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1328+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1329+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1330+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
13311331
:return: the bundle.
13321332
"""
13331333
if app_mode is None:
@@ -1433,10 +1433,10 @@ def create_notebook_manifest_and_environment_file(
14331433
:param hide_tagged_input: If True, will hide input code cells with the 'hide_input' tag
14341434
when rendering output. Previous default = False.
14351435
:param image: an optional docker image for off-host execution. Previous default = None.
1436-
:param env_management_py: False indicates that the user is responsible for Python package installation
1437-
in the runtime environment. Default = None.
1438-
:param env_management_r: False indicates that the user is responsible for R package installation
1439-
in the runtime environment. Default = None.
1436+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1437+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1438+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1439+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
14401440
:return:
14411441
"""
14421442
warn("This method has been moved and will be deprecated.", DeprecationWarning, stacklevel=2)
@@ -1477,10 +1477,10 @@ def write_notebook_manifest_json(
14771477
:param hide_tagged_input: If True, will hide input code cells with the 'hide_input' tag
14781478
when rendering output. Previous default = False.
14791479
:param image: the optional docker image to be specified for off-host execution. Default = None.
1480-
:param env_management_py: False indicates that the user is responsible for Python package installation
1481-
in the runtime environment. Default = None.
1482-
:param env_management_r: False indicates that the user is responsible for R package installation
1483-
in the runtime environment. Default = None.
1480+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1481+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1482+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1483+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
14841484
:return: whether or not the environment file (requirements.txt, environment.yml,
14851485
etc.) that goes along with the manifest exists.
14861486
"""
@@ -1536,10 +1536,10 @@ def create_api_manifest_and_environment_file(
15361536
:param force: if True, forces the environment file to be written. even if it
15371537
already exists. Previous default = True.
15381538
:param image: the optional docker image to be specified for off-host execution. Default = None.
1539-
:param env_management_py: False indicates that the user is responsible for Python package installation
1540-
in the runtime environment. Default = None.
1541-
:param env_management_r: False indicates that the user is responsible for R package installation
1542-
in the runtime environment. Default = None.
1539+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1540+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1541+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1542+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
15431543
:return:
15441544
"""
15451545
warn("This method has been moved and will be deprecated.", DeprecationWarning, stacklevel=2)
@@ -1575,10 +1575,10 @@ def write_api_manifest_json(
15751575
:param extra_files: any extra files that should be included in the manifest. Previous default = None.
15761576
:param excludes: a sequence of glob patterns that will exclude matched files. Previous default = None.
15771577
:param image: the optional docker image to be specified for off-host execution. Default = None.
1578-
:param env_management_py: False indicates that the user is responsible for Python package installation
1579-
in the runtime environment. Default = None.
1580-
:param env_management_r: False indicates that the user is responsible for R package installation
1581-
in the runtime environment. Default = None.
1578+
:param env_management_py: False prevents Connect from managing the Python environment for this bundle.
1579+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
1580+
:param env_management_r: False prevents Connect from managing the R environment for this bundle.
1581+
The server administrator is responsible for installing packages in the runtime environment. Default = None.
15821582
:return: whether or not the environment file (requirements.txt, environment.yml,
15831583
etc.) that goes along with the manifest exists.
15841584
"""

0 commit comments

Comments
 (0)