Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update description for --assign-agent option #1489

Merged
merged 3 commits into from
Aug 20, 2023

Conversation

dlwldnjs1009
Copy link
Contributor

@dlwldnjs1009 dlwldnjs1009 commented Aug 18, 2023

Description:

What changes:
This Pull Request corrects the description of the --assign-agent option in the Backend.AI CLI. The previous description suggested that this option is used to display a mapping list of tuples which mapped containers with agents.

Justification:
The --assign-agent option is actually used to assign specific agents to a session. This functionality is only applicable when the user role is a Super Admin. This discrepancy between the actual functionality and the description in the code can lead to confusion for users and developers.

Before:

@click.option(
    "--assign-agent",
    default=None,
    type=list_expr,
    help=(
        "Show mapping list of tuple which mapped containers with agent. "
        "When user role is Super Admin. "
        "(e.g., --assign-agent agent_id_1,agent_id_2,...)"
    ),
)

After:

@click.option(
    "--assign-agent",
    default=None,
    type=list_expr,
    help=(
        "Assign specific agents to the session. "
        "This option is only applicable when the user role is Super Admin. "
        "(e.g., --assign-agent agent_id_1,agent_id_2,...)"
    ),
)

PR description

resolves lablup#5

@github-actions github-actions bot added comp:client Related to Client component size:XS ~10 LoC labels Aug 18, 2023
@kyujin-cho kyujin-cho added the ossca-23 OSS Contribution Academy mentee's contributions. label Aug 18, 2023
@kyujin-cho kyujin-cho added this to the 23.03 milestone Aug 18, 2023
@kyujin-cho kyujin-cho modified the milestones: 23.03, 23.09 Aug 20, 2023
@kyujin-cho kyujin-cho added area:docs Documentations skip:changelog Make the action workflow to skip towncrier check and removed area:docs Documentations labels Aug 20, 2023
@kyujin-cho kyujin-cho added this pull request to the merge queue Aug 20, 2023
Merged via the queue into lablup:main with commit b0b0178 Aug 20, 2023
11 of 12 checks passed
@kyujin-cho kyujin-cho deleted the fix/assign-agent-description branch August 20, 2023 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp:client Related to Client component ossca-23 OSS Contribution Academy mentee's contributions. size:XS ~10 LoC skip:changelog Make the action workflow to skip towncrier check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect description for --assign-agent option in CLI
2 participants