protocolbuffers / protocolbuffers/protobuf
Generated PHP code with incorrect comment formating
Open
Nobody has claimed this yet.
help wanted
php
- Dominant language
- C++
- Stars
- 72k
- Forks
- 16.3k
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 140
Description
Language: PHP
What did you do?
Steps to reproduce the behavior:
- Go to https://github.com/googleapis/google-cloud-php/pull/6737/files
- Click on
Dataform/src/V1beta1/Client/DataformClient.php - Scroll down to
setIamPolicyand see the code block over the method, it has missing asterisk sign in comments.
What did you expect to see
All comments start with asterisk.
What did you see instead?
ref
/**
* Sets the access control policy on the specified resource. Replaces
any existing policy.
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
errors.
*
* The async variant is {@see DataformClient::setIamPolicyAsync()} .
*
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the generated Dataform/src/V1beta1/Client/DataformClient.php shown in the linked pull request, especially setIamPolicy and the referenced lines. Trace that generated output back to the PHP code-generation entry point, then regenerate the client and verify that every line in the affected comments begins with an asterisk.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100