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.

Sign up for GitHub

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

Fix check-packages command docstring #689

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Fix check-packages command docstring #689

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions aea/cli/check_packages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,16 +603,7 @@ def check_pypi_dependencies(configuration_file: Path) -> None:
@click.option("--vendor", type=str, default=None, required=False)
@pass_ctx
def check_packages(ctx: Context, vendor: Optional[str]) -> None:
"""
Run different checks on AEA packages.

Namely:
- Check that every package has existing dependencies
- Check that every package has non-empty description

:param ctx: AEA cli context.
:param vendor: filter by author name
"""
"""Run different checks on AEA packages."""
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This produces following command help string

Usage: autonomy check-packages [OPTIONS]

  Run different checks on AEA packages.

  Namely: - Check that every package has existing dependencies - Check that
  every package has non-empty description

  :param ctx: AEA cli context. :param vendor: filter by author name

Options:
  --vendor TEXT
  --help         Show this message and exit.

This is a limitation of click

packages_dir = Path(ctx.registry_path).absolute()
all_packages_ids_ = find_all_packages_ids(packages_dir)
failed: bool = False
Expand Down
Loading