docs: Use preformatted strings in fmt help #7263
Conversation
Without this, the `--` are rendered in HTML as `–` making the commands with flags incorrect in the docs. Signed-off-by: Charlie Egan <[email protected]>
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Good to fix the html rendering! But what does this look like on the command line? |
|
I thought it looked alright, but to be fair there is not precedent for this already in other commands... I am unsure how best to do it otherwise. 
Perhaps there are some more options we can press on https://github.com/spf13/cobra/blob/01ffff4eca5a08384ef2b85f39ec0dac192a5f7b/doc/md_docs.go#L68 that would be preferred. |
|
Yeah, it's not terrible, but not ideal. I remember writing the "generator" for this back in the day, and that we do some customizations in there already. https://github.com/open-policy-agent/opa/blob/main/build/generate-cli-docs/generate.go Not sure if it'd be easy to identify these locations and change only for HTML rendering. Not worth spending too much time on though, so if that's needed, I think this is fine to keep as is. |
Without this, the
--are rendered in HTML as–making the commands with flags incorrect in the docs.before
after
