docs: add comment about why the replacement strategies are necessary

cpcloud · Nov 26, 2021 · f98e41c · f98e41c
1 parent c9370cd
commit f98e41c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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