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

Properly format manual sample code #367

Closed
bjwatson opened this issue Jun 13, 2016 · 4 comments
Closed

Properly format manual sample code #367

bjwatson opened this issue Jun 13, 2016 · 4 comments
Assignees
Labels
🚨 This issue needs some love. triage me I really want to be triaged.

Comments

@bjwatson
Copy link

For example, see http://pythonhosted.org/gax-google-pubsub-v1/google.protobuf.timestamp_pb2.html#module-google.protobuf.timestamp_pb2. This manually written sample code is poorly formatted in the Python doc.

We will probably need some kind of hint in the proto file that it's sample code, such as the markdown conventional ```.

@bjwatson
Copy link
Author

I fixed the public link above to render properly, by manually adding '::' to the line before each code sample. This issue is for eventually automating this, instead of manually tweaking the auto-gen results.

@bjwatson
Copy link
Author

The proto comments is markdown, so four leading spaces is our hint that it's code.

@bjwatson
Copy link
Author

Parent issue is googleapis/gapic-generator#331

@geigerj geigerj removed their assignment Feb 26, 2018
@yihanzhen yihanzhen transferred this issue from googleapis/gapic-generator Apr 9, 2020
@yoshi-automation yoshi-automation added 🚨 This issue needs some love. triage me I really want to be triaged. labels Apr 9, 2020
@yihanzhen yihanzhen removed their assignment Apr 10, 2020
@software-dov
Copy link
Contributor

Out of scope for microgenerator.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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