dagster-io / dagster

An orchestration platform for the development, production, and observation of data assets.
https://dagster.io
Apache License 2.0
11.91k stars 1.49k forks source link

CLI commands help is truncated in docs #26064

Open cooperellidge opened 5 days ago

cooperellidge commented 5 days ago

What's the issue or suggestion?

All of the CLI command help text is truncated after 40-50 characterss.

https://docs.dagster.io/_apidocs/cli

For example:

dagster asset materialize

in the docs has help text: "Execute a run to materialize a selection…"

but in code has help text fully defined: "Execute a run to materialize a selection of assets"

https://github.com/search?q=repo%3Adagster-io%2Fdagster+%22Execute+a+run+to+materialize+a+selection%22&type=code

This appear to happen to all CLI command, but not options or arguments.

Additional information

Potentially related Click and sphinx-click issues:

https://github.com/click-contrib/sphinx-click/issues/56 https://github.com/pallets/click/issues/2149

Message from the maintainers

Impacted by this issue? Give it a đź‘Ť! We factor engagement into prioritization.