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

compute: misformatted comment for Operation #712

Closed
dowgird opened this issue Oct 19, 2020 · 1 comment · Fixed by #789
Closed

compute: misformatted comment for Operation #712

dowgird opened this issue Oct 19, 2020 · 1 comment · Fixed by #789
Assignees
Labels
api: compute Issues related to the Compute Engine API. type: docs Improvement to the documentation for an API.

Comments

@dowgird
Copy link

dowgird commented Oct 19, 2020

This is the docstring generated for Operation:

// *
// [Global](/compute/docs/reference/rest/{$api_version}/globalOperations)
//  *
// [Regional](/compute/docs/reference/rest/{$api_version}/regionOperation
// s) *
// [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
//
// Y
// ou can use an operation resource to manage asynchronous API requests.

It's weirdly formatted and renderss badly in HTML, for example here: https://pkg.go.dev/google.golang.org/api@v0.33.0/compute/v1#Operation

I'm referring to compute/v0.alpha/compute-gen.go, PR #707

@product-auto-label product-auto-label bot added the api: compute Issues related to the Compute Engine API. label Oct 19, 2020
@codyoss
Copy link
Member

codyoss commented Oct 19, 2020

Thanks for pointing this out. Appears to be the same issue as #544. I will track the progress of the issue here and close other issues. Also related to #457.

@codyoss codyoss added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Oct 19, 2020
@tbpg tbpg added type: docs Improvement to the documentation for an API. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Nov 17, 2020
gcf-merge-on-green bot pushed a commit that referenced this issue Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: compute Issues related to the Compute Engine API. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants