Skip to content

docs(asg,ecs): fix incorrect CLI examples and add missing Usage blocks#258

Merged
duplodavid merged 1 commit intomainfrom
docs/asg-ecs-docstring-fixes
Apr 23, 2026
Merged

docs(asg,ecs): fix incorrect CLI examples and add missing Usage blocks#258
duplodavid merged 1 commit intomainfrom
docs/asg-ecs-docstring-fixes

Conversation

@amaechiabuah
Copy link
Copy Markdown
Collaborator

Describe Changes

Resource-specific docstring fixes for the asg and ecs resources. Scope deliberately excludes the shared template-mechanism issue (where inherited V2/V3 docstrings render the wrong CLI name for some resources) — that's a follow-up PR.

asg

  • create docstring showed duploctl hosts create — corrected to duploctl asg create.
  • scale docstring advertised a non-existent -n <name> flag (customer got unrecognized arguments: -n). Updated to positional usage.

ecs

Audited every @Command in ecs_service.py; 8 of 14 had no Usage: CLI Usage block. Added blocks for create_service, update_service, update_taskdef, delete_service, find_def, find_def_by_arn, find_service_family, and find_task_def_family.

Also caught a latent bug: list_task_def_family referenced a non-existent duploctl ecs list_definitions command in its example. Fixed to use the actual method name.

Docs-only change — no code behavior changed, so no new tests. Verified mkdocs build emits no new griffe warnings for the touched files, and the existing unit tests for asg/ecs still pass.

Link to Issues

PR Review Checklist

  • Thoroughly reviewed on local machine.
  • Have you added any tests — N/A, docs-only change
  • Make sure to note changes in Changelog

@zafarabbas
Copy link
Copy Markdown
Contributor

@duploctl
Copy link
Copy Markdown
Contributor

duploctl Bot commented Apr 21, 2026

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
3701 1433 39% 0% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
src/duplo_resource/asg.py 0% 🟢
src/duplo_resource/ecs_service.py 67% 🟢
TOTAL 33% 🟢

updated for commit: 7e328c3 by action🐍

@duplodavid duplodavid merged commit c298f4e into main Apr 23, 2026
7 checks passed
@duplodavid duplodavid deleted the docs/asg-ecs-docstring-fixes branch April 23, 2026 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants