grpc / grpc/grpc-java

Clarify the Javadoc for CallStreamObserver

オープン
#6,552 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る
docs enhancement
主要言語
Java
スター
12.1k
フォーク
4k
平均マージ
2日 17時間
マージ済み PR(30日)
37

説明

The relevant part of the current Javadoc:
https://github.com/grpc/grpc-java/blob/6b04fc18f30deb3519c389fe457b99cf5a8d99d0/stub/src/main/java/io/grpc/stub/CallStreamObserver.java#L25-L35

As far as I can tell, for any call, there are three implementations of `StreamObserver` involved:
1) Implemented by the application, on the RPC client side ('inbound')
2) Implemented by the framework, on the RPC client side ('outbound'), `ClientCallStreamObserver`
3) Implemented by the framework, on the RPC server side ('outbound'), `ServerCallStreamObserver`

I think it would be nice to clarify that. I've spent significant time trying to understand where does `ClientCallStreamObserver` appear, being confused by the premise that there are only two implementations of `StreamObserver`.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Start with stub/src/main/java/io/grpc/stub/CallStreamObserver.java, especially the Javadoc at lines 25–35 linked in the issue. Clarify the three StreamObserver implementations and the roles of ClientCallStreamObserver and ServerCallStreamObserver; the Javadoc should make where ClientCallStreamObserver appears understandable.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。