test: parameter description contains Markdown #94
Conversation
There was a problem hiding this comment.
I'm leaning towards optimizing syntax for the web interface rather than the CLI, because it's presently unclear in the syntax when description would be shown and when description_markdown would be.
What do you think about making description markdown by default, then add a description_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. |
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
descriptionand then strip Markdown tags from descriptions in CLI, but when I looked at the logic required to perform this (rewritten to Go), I decided to KISS and use a dedicated property, that is only processed by the site.