Skip to content

Commit

Permalink
Doc string fix and tweaks
Browse files Browse the repository at this point in the history
In those places where we return an object that implements two
interfaces (let's say P and Q), consistently describe it as a "P-Q"
rather than once mentioning that it is a P and describing it as a "Q"
for the rest of prose.
  • Loading branch information
nathanielmanistaatgoogle committed Jan 19, 2017
1 parent d1cfffe commit d9ed84f
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions src/python/grpcio/grpc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -487,9 +487,9 @@ def future(self, request, timeout=None, metadata=None, credentials=None):
Returns:
An object that is both a Call for the RPC and a Future. In the event of
RPC completion, the return Future's result value will be the response
message of the RPC. Should the event terminate with non-OK status, the
returned Future's exception value will be an RpcError.
RPC completion, the return Call-Future's result value will be the
response message of the RPC. Should the event terminate with non-OK
status, the returned Call-Future's exception value will be an RpcError.
"""
raise NotImplementedError()

Expand All @@ -510,8 +510,8 @@ def __call__(self, request, timeout=None, metadata=None, credentials=None):
Returns:
An object that is both a Call for the RPC and an iterator of response
values. Drawing response values from the returned iterator may raise
RpcError indicating termination of the RPC with non-OK status.
values. Drawing response values from the returned Call-iterator may
raise RpcError indicating termination of the RPC with non-OK status.
"""
raise NotImplementedError()

Expand All @@ -535,8 +535,7 @@ def __call__(self,
credentials: An optional CallCredentials for the RPC.
Returns:
The response value for the RPC, and a Call for the RPC if with_call was
set to True at invocation.
The response value for the RPC.
Raises:
RpcError: Indicating that the RPC terminated with non-OK status. The
Expand Down Expand Up @@ -587,9 +586,9 @@ def future(self,
Returns:
An object that is both a Call for the RPC and a Future. In the event of
RPC completion, the return Future's result value will be the response
message of the RPC. Should the event terminate with non-OK status, the
returned Future's exception value will be an RpcError.
RPC completion, the return Call-Future's result value will be the
response message of the RPC. Should the event terminate with non-OK
status, the returned Call-Future's exception value will be an RpcError.
"""
raise NotImplementedError()

Expand All @@ -614,8 +613,8 @@ def __call__(self,
Returns:
An object that is both a Call for the RPC and an iterator of response
values. Drawing response values from the returned iterator may raise
RpcError indicating termination of the RPC with non-OK status.
values. Drawing response values from the returned Call-iterator may
raise RpcError indicating termination of the RPC with non-OK status.
"""
raise NotImplementedError()

Expand Down

0 comments on commit d9ed84f

Please sign in to comment.