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

passed custom template in BuildApp() #153

Closed
wants to merge 8 commits into from
Closed

passed custom template in BuildApp() #153

wants to merge 8 commits into from

Conversation

DJSanti
Copy link
Contributor

@DJSanti DJSanti commented Mar 15, 2023

What was changed

A custom help template was massed in the arguments for BuildApp().

Why?

The template prevents text meant for documentation (text with markdown) from being displayed in the CLI tool itself.

Checklist

  • Pass variable
  • Compile and confirm that it works

How was this tested:

Compiled app and ran commands and -h.

Any docs updates needed?

Documents will be updated upon next generation.

@DJSanti DJSanti added the documentation Improvements or additions to documentation label Mar 15, 2023
@DJSanti DJSanti self-assigned this Mar 15, 2023
@bergundy
Copy link
Member

Nice, we still have some work here but I'm no longer seeing markdown rendered.

I'm seeing [arguments...] show up in commands that don't support them, e.g:

   temporal task-queue describe [command options] [arguments...]

And very long lines that are hard to read and should be broken up, e.g:

   The Server records the last time of each poll request. Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. Once it has been 5 minutes since the last poll request, the Worker is removed from the list.

@bergundy
Copy link
Member

Hmm... nope still seeing markdown rendered:

$ temporal workflow --help
NAME:
   temporal workflow - Operations that can be performed on Workflows.

USAGE:
   Workflow commands allow operations to be performed on [Workflow Executions](/concepts/what-is-a-workflow-execution).

Please review all of the help outputs and verify we don't render markdown.
We should consider having a single help text in markdown form and rendering it as text when printed to console.

@DJSanti
Copy link
Contributor Author

DJSanti commented Mar 15, 2023

declared the template explicitly for main commands.

edited the condition for printing [arguments...].

@DJSanti
Copy link
Contributor Author

DJSanti commented Mar 21, 2023

Might close this PR if Ruslan has a better idea

@DJSanti DJSanti closed this Mar 22, 2023
@cretz cretz deleted the cli-help-fix branch April 29, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants