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.

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

CLI commands help is truncated in docs #26064

Open
cooperellidge opened this issue Nov 20, 2024 · 0 comments
Open

CLI commands help is truncated in docs #26064

cooperellidge opened this issue Nov 20, 2024 · 0 comments
Labels
area: docs Related to documentation in general

Comments

@cooperellidge
Copy link
Contributor

cooperellidge commented Nov 20, 2024

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:

click-contrib/sphinx-click#56
pallets/click#2149

Message from the maintainers

Impacted by this issue? Give it a 👍! We factor engagement into prioritization.

@cooperellidge cooperellidge added the area: docs Related to documentation in general label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general
Projects
None yet
Development

No branches or pull requests

1 participant