Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

Don't use markdown in VKit comments #475

Closed
pongad opened this issue Sep 12, 2016 · 5 comments
Closed

Don't use markdown in VKit comments #475

pongad opened this issue Sep 12, 2016 · 5 comments
Assignees
Labels
🚨 This issue needs some love. triage me I really want to be triaged.

Comments

@pongad
Copy link
Contributor

pongad commented Sep 12, 2016

Comments like

the `x-goog-api-client` header

should have the backticks removed.

@pongad pongad self-assigned this Sep 12, 2016
@bjwatson
Copy link
Contributor

@geigerj
Copy link
Contributor

geigerj commented Sep 14, 2016

See also

https://github.com/googleapis/toolkit/blob/master/src/main/java/com/google/api/codegen/CommentPatterns.java

and

https://github.com/googleapis/toolkit/blob/master/src/main/java/com/google/api/codegen/py/PythonSphinxCommentFixer.java

for what Python does here. As discussed offline it would eventually be good to get a proper Markdown processor hooked up to this, like what we have internally.

@bjwatson
Copy link
Contributor

@pongad @garrettjonesgoogle This seems like a duplicate of #331. I like how 331 is phrased better, because I want to make use of the backticks as a hint for code formatting, rather than just removing them (which only makes sense if a language's doc system has zero support for code formatting).

Unless I'm missing something subtle, one of these should be closed.

@garrettjonesgoogle
Copy link
Member

Yeah, probably close this one (475).

@pongad
Copy link
Contributor Author

pongad commented Sep 16, 2016

Duplicate of #331

@pongad pongad closed this as completed Sep 16, 2016
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Apr 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🚨 This issue needs some love. triage me I really want to be triaged.
Projects
None yet
Development

No branches or pull requests

5 participants