Skip to content

Add PHPDoc for ServerStream iterator types #771

@bshaffer

Description

@bshaffer

We currently document ServerStream as the return type for server streaming types. This is not very useful, as we need to know what the type is that the ServerStream returns when you iterate over the results. Otherwise the only way for the customer to know what is returned is to make the call and wait, or to look at the source protos:

Example:

A better solution would be to have the @return phpdoc look like this:

* @return ServerStream<PartialResultSet>

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p3Desirable enhancement or fix. May not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions