fix: Correct help text formatting for adk deploy agent_engine
#1250
+1
−16
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
Args:
section in the docstring of thecli_deploy_agent_engine
function was causing formatting issues in the help output, with line breaks not being rendered correctly.This commit removes the redundant
Args:
section from the docstring. The help text for options is already comprehensively covered by thehelp
attributes in the@click.option
decorators, andclick
automatically lists the command's arguments.This change ensures that the help output for
adk deploy agent_engine --help
is clean, readable, and correctly formatted, relying onclick
's standard help generation mechanisms.After the fix:
(adk_test234) (base) hangfeilin@Hangfeis-MBP adk-python % adk deploy agent_engine --help
Usage: adk deploy agent_engine [OPTIONS] AGENT
Deploys an agent to Agent Engine.
Args: agent (str): Required. The path to the agent to be deloyed.
Example:
Options:
--project TEXT Required. Google Cloud project to deploy the agent.
--region TEXT Required. Google Cloud region to deploy the agent.
--staging_bucket TEXT Required. GCS bucket for staging the deployment artifacts.
--trace_to_cloud Optional. Whether to enable Cloud Trace for Agent Engine.
--adk_app TEXT Optional. Python file for defining the ADK application (default: a file named agent_engine_app.py)
--temp_folder TEXT Optional. Temp folder for the generated Agent Engine source files. If the folder already exists, its
contents will be removed. (default: a timestamped folder in the system temp directory).
--env_file TEXT Optional. The filepath to the
.env
file for environment variables. (default: the.env
file inthe
agent
directory, if any.)--requirements_file TEXT Optional. The filepath to the
requirements.txt
file to use. (default: therequirements.txt
filein the
agent
directory, if any.)--help Show this message and exit.