Skip to content

update help text for log drains#376

Merged
benjodo merged 7 commits intomasterfrom
log_drain_help_text
Mar 19, 2025
Merged

update help text for log drains#376
benjodo merged 7 commits intomasterfrom
log_drain_help_text

Conversation

@michaelwang13
Copy link
Copy Markdown
Member

@michaelwang13 michaelwang13 commented Mar 3, 2025

Consistenly use - for options across log drain creation commands.

Make it more clear what the default behavior is in the help text, since Thor makes it confusing by including the --no- versions for booleans.

Screenshot 2025-03-03 at 11 37 28 AM

Alternatives would be to build Thor ourselves to get rid of it, or manage the default: true ourselves.

@michaelwang13 michaelwang13 requested a review from benjodo March 3, 2025 16:44
Copy link
Copy Markdown
Member

@UserNotFound UserNotFound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a nit, or i've just seen the word "drain" too much for it to hold any meaning to me anymore...but can we change the help text from "will be drained" to "will be sent to your chosen destination" or something?

@eloisejones
Copy link
Copy Markdown

Maybe a nit, or i've just seen the word "drain" too much for it to hold any meaning to me anymore...but can we change the help text from "will be drained" to "will be sent to your chosen destination" or something?

I second this suggestion. I think it would help make things clearer.

@michaelwang13
Copy link
Copy Markdown
Member Author

updated!

Copy link
Copy Markdown
Member

@UserNotFound UserNotFound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I didn't notice this the first time, but you need to include a space for each \ on all of these help blurbs that were changed.
image

@benjodo benjodo merged commit 43600c7 into master Mar 19, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants