From: Erlend E. Aasland <erlend@python.org>
Date: Wed, 9 Aug 2023 05:55:34 +0000 (+0200)
Subject: gh-80282: Argument Clinic: Add clarifying comment about ASCII docstring limitation... 
X-Git-Tag: v3.13.0a1~1022
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=925bbc2166d169962210314772d13270e9ba60a2;p=thirdparty%2FPython%2Fcpython.git

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

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
---

diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
index 16f31717080e..059c2db27288 100755
--- a/Tools/clinic/clinic.py
+++ b/Tools/clinic/clinic.py
@@ -5461,6 +5461,11 @@ class DSLParser:
 
     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:",