grpc / grpc/grpc-java

Clarify the Javadoc for CallStreamObserver

Ouverte
#6,552 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
docs enhancement
Langage dominant
Java
Étoiles
12.1k
Forks
4k
Merge moyen
2 j 17 h
PR mergées (30 j)
37

Description

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`.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.