docs: improve command descriptions with non-obvious details by jeremybeard · Pull Request #2059 · astronomer/astro-cli
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.
marked this pull request as ready for review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters