- Notifications
You must be signed in to change notification settings - Fork23
test: parameter description contains Markdown#94
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
LGTM!
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'm leaning towards optimizing syntax for the web interface rather than the CLI, because it's presently unclear in the syntax whendescription
would be shown and whendescription_markdown
would be.
What do you think about makingdescription
markdown by default, then add adescription_plaintext
for the CLI? Another option is to display the markdown as text in the CLI, which I don't think is bad. Markdown is pretty readable anyways (I think this might be my preference actually).
Thanks for jumping in,@kylecarbs.
TIL! I think that we have to highlight who is the more important consumer, CLI or site. We can use it as the rule of thumb that in our case it's always the site.
If we're site-oriented, then Let me know your thoughts. |
That makes sense to me. I like it! |
Maybe I will update examples to show that Markdown description is fine. |
Uh oh!
There was an error while loading.Please reload this page.
Related:coder/coder#5931
This PR improves tests to present that the Markdown format is acceptable for the parameter description.
This PR introduces a new Markdown property to render rich descriptions, with Markdown tags included (see example).Comment:I admit that I wanted to use the
description
and then strip Markdown tags from descriptions in CLI, but when I looked at thelogic required to perform this (rewritten to Go), I decided to KISS and use a dedicated property, that is only processed by the site.