protocolbuffers/protobuf

Generated PHP code with incorrect comment formating

Open

#14,563 opened on Oct 31, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (16,128 forks)batch import
help wantedphp

Repository metrics

Stars
 (71,223 stars)
PR merge metrics
 (Avg merge 2d 11h) (185 merged PRs in 30d)

Description

Language: PHP

What did you do? Steps to reproduce the behavior:

  1. Go to https://github.com/googleapis/google-cloud-php/pull/6737/files
  2. Click on Dataform/src/V1beta1/Client/DataformClient.php
  3. Scroll down to setIamPolicy and 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

Research direction
Examine the protobuf PHP code generator template for doc comments to identify where the missing asterisk is introduced.
Tech stack
php
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PHPcode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85