From a57d678230fb75e1c9b6070494919eb703c11442 Mon Sep 17 00:00:00 2001
From: Thomas Pelletier <thomas@pelletier.codes>
Date: Mon, 29 Jan 2024 18:17:17 -0500
Subject: [PATCH] Document tests/executor_service

---
 tests/executor_service.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/tests/executor_service.py b/tests/executor_service.py
index 996adb18..245426a2 100644
--- a/tests/executor_service.py
+++ b/tests/executor_service.py
@@ -3,6 +3,13 @@
 import ring.coroutine.v1.coroutine_pb2
 import ring.coroutine.v1.coroutine_pb2_grpc
 
+# This file provides a grpc client that can talk to the ExecutorService
+# interface. This is achieved by implementing the bare minimum of the
+# grpc.Channel using httpx to make the requests, which allows us to use the
+# same httpx client as the FastAPI testing framework.
+#
+# See test_fastapi.py for an example of how to use this client.
+
 
 class UnaryUnaryMultiCallable(grpc.UnaryUnaryMultiCallable):
     def __init__(self, client, method, request_serializer, response_deserializer):