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

Update help text to conform to style #662

Merged
merged 1 commit into from
Sep 12, 2024
Merged

Update help text to conform to style #662

merged 1 commit into from
Sep 12, 2024

Conversation

josh-berry
Copy link
Collaborator

  • Clean up temporal operator nexus commands since they wrap beyond 80 columns (and this would be visible to the user).
  • Clarify wording on temporal task-queue describe, which was rather confusing in some places.

Both of these got scrutinized because they changed in the nexus branch, but not in main, so they would not have been seen by our docs folks.

@josh-berry josh-berry force-pushed the josh/nexus-help branch 3 times, most recently from 7f23342 to 472426a Compare September 12, 2024 18:48
- Clean up `temporal operator nexus` commands since they wrap beyond 80
  columns (and this would be visible to the user).
- Clarify wording on `temporal task-queue describe`, which was rather
  confusing in some places.

Both of these got scrutinized because they changed in the `nexus`
branch, but not in `main`, so they would not have been seen by our docs
folks.
Copy link
Member

@bergundy bergundy left a comment

Choose a reason for hiding this comment

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

Feels like there's some redundant new lines now but if that's inline with the other commands I don't have any objections.

@josh-berry
Copy link
Collaborator Author

Feels like there's some redundant new lines now but if that's inline with the other commands I don't have any objections.

It's in line with the others, yeah. I agree with you it's a little weird, but it was helpful to distinguish things that are semantically meaningful (like Required.) vs. things that aren't. This should get cleaned up in general when we move to a YAML format.

Thanks for taking a look!

@josh-berry josh-berry merged commit 114d743 into nexus Sep 12, 2024
6 checks passed
@josh-berry josh-berry deleted the josh/nexus-help branch September 12, 2024 19:16
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.

2 participants