gh-80282: Argument Clinic: Add clarifying comment about ASCII docstring limitation (#107764)

erlend-aasland · AlexWaygood · web-flow · commit 925bbc2166d1 · 2023-08-09T07:55:34.000+02:00
Co-authored-by: Alex Waygood &lt;Alex.Waygood@Gmail.com&gt;
diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
@@ -5461,6 +5461,11 @@ def state_parameter_docstring_start(self, line: str) -> None:
 
     def docstring_append(self, obj: Function | Parameter, line: str) -> None:
         """Add a rstripped line to the current docstring."""
+        # gh-80282: We filter out non-ASCII characters from the docstring,
+        # since historically, some compilers may balk on non-ASCII input.
+        # If you're using Argument Clinic in an external project,
+        # you may not need to support the same array of platforms as CPython,
+        # so you may be able to remove this restriction.
         matches = re.finditer(r'[^\x00-\x7F]', line)
         if offending := ", ".join([repr(m[0]) for m in matches]):
             warn("Non-ascii characters are not allowed in docstrings:",
