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

Updates CLI deployment run --help text so it renders for more args #11960

Merged
merged 8 commits into from
Feb 20, 2024

Conversation

discdiver
Copy link
Contributor

@discdiver discdiver commented Feb 9, 2024

Closes #11957

A number of arguments were not showing in the CLI for prefect deployment run --help. Some of the code had incorrect formatting (multil-line strings appear to need to be wrapped in parentheses for typer to render them) and some items were missing text.
Looked at all help=" for CLI commands.

Example

Before:
Screenshot 2024-02-09 at 5 40 27 PM

After:
Screenshot 2024-02-09 at 5 40 48 PM

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • This pull request includes tests or only affects documentation.
  • This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.

For documentation changes:

  • This pull request includes redirect settings in netlify.toml for files that are removed or renamed.

For new functions or classes in the Python SDK:

  • This pull request includes helpful docstrings.
  • If a new Python file was added, this pull request contains a stub page in the Python SDK docs and an entry in mkdocs.yml navigation.

@discdiver discdiver added the fix A fix for a bug in an existing feature label Feb 9, 2024
Copy link

netlify bot commented Feb 9, 2024

Deploy Preview for prefect-docs-preview ready!

Name Link
🔨 Latest commit 3fb5eac
🔍 Latest deploy log https://app.netlify.com/sites/prefect-docs-preview/deploys/65cfb614f74e4c0008ee6289
😎 Deploy Preview https://deploy-preview-11960--prefect-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@discdiver discdiver marked this pull request as ready for review February 9, 2024 22:41
@discdiver discdiver requested a review from a team as a code owner February 9, 2024 22:41
@discdiver
Copy link
Contributor Author

This omission was noted by a participant at PACC this week - nice to be able to show the fix is in flight. :)

@chrisguidry chrisguidry merged commit e4fe0fa into main Feb 20, 2024
44 checks passed
@chrisguidry chrisguidry deleted the cli-help branch February 20, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix A fix for a bug in an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing optional prefect deployment run CLI arguments to --help
2 participants