-
Notifications
You must be signed in to change notification settings - Fork 13
Add PHPDoc for ServerStream iterator types #771
Copy link
Copy link
Open
Labels
priority: p3Desirable enhancement or fix. May not be included in next release.Desirable enhancement or fix. May not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.‘Nice-to-have’ improvement, new feature or different behavior or design.
Metadata
Metadata
Assignees
Labels
priority: p3Desirable enhancement or fix. May not be included in next release.Desirable enhancement or fix. May not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.‘Nice-to-have’ improvement, new feature or different behavior or design.
Type
Fields
Give feedbackNo fields configured for issues without a type.
We currently document
ServerStreamas the return type for server streaming types. This is not very useful, as we need to know what the type is that theServerStreamreturns 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
@returnphpdoc look like this: