From f98e41c208f804627e81a7aba3a4b21708eaac5c Mon Sep 17 00:00:00 2001
From: Phillip Cloud <417981+cpcloud@users.noreply.github.com>
Date: Fri, 26 Nov 2021 09:05:03 -0500
Subject: [PATCH] docs: add comment about why the replacement strategies are
 necessary

---
 protoletariat/fdsetgen.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/protoletariat/fdsetgen.py b/protoletariat/fdsetgen.py
index 90ca61bd..c4047daa 100644
--- a/protoletariat/fdsetgen.py
+++ b/protoletariat/fdsetgen.py
@@ -46,6 +46,10 @@ def fix_imports(
             fd_name = _remove_proto_suffix(fd.name)
             rewriters[fd_name] = rewriter = ChainedImportRewriter(
                 ASTImportRewriter(),
+                # FIXME: mypy_protoc generates broken pyi files for long lines
+                # StringReplaceImportRewriter is an architectural workaround
+                # to allow replacement of strings so that the pyis might be able
+                # to work
                 StringReplaceImportRewriter(),
             )
             # services live outside of the corresponding generated Python