astronomer / astro-cli / e2adb129-3f22-49ba-9942-e8b3251a2b53

37%

main: 39%

Build Type

Pull #2059

circleci

Committed by jeremybeard

Commit Message

docs: improve command descriptions with non-obvious details

Replace ~50 minimal Long descriptions (identical to Short) with
substantive descriptions informed by core API business logic.

Key improvements:
- Workspace delete: documents that Deployments must be removed first
  and that Workspace-scoped tokens are revoked
- Deployment delete: documents cascading data loss (DAGs, metadata,
  tokens, alerts) and that running tasks are terminated
- Token create/rotate: documents that values are shown only once
- Team create: documents SCIM/IDP blocking behavior
- Team delete: documents cascading role binding removal
- Worker queue create: documents KubernetesExecutor single-queue
  limit and naming constraints

Also fixes typos: "Organaization" → "Organization",
"Update a the role" → "Update the role",
"you have access too" → "you have access to"

Removes 66 brittle help-text assertion subtests that broke on any
description change, replacing zero behavioral coverage.

Pull Request Pull Request #2059: docs: improve command descriptions with non-obvious details

Run Details

61 of 61 new or added lines in 7 files covered. (100.0%)

16 existing lines in 1 file now uncovered.

24453 of 67833 relevant lines covered (36.05%)

8.09 hits per line