{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 35.7k
GH-137623: Begin enforcing docstring length in Argument Clinic #137624
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
20a6a43
Begin enforcing docstring length in Argument Clinic
AA-Turner 5803939
Set to 72 chars and check body lines
AA-Turner 48b617b
Fix tests
AA-Turner cac9891
Use 68 characters for methods
AA-Turner b3acb91
Revert repr change
AA-Turner 223dc29
Merge branch 'main' into clinic/overlong-docstrings
AA-Turner 980b95a
post-merge
AA-Turner 3bc4f20
72/76
AA-Turner 2216db9
Update docstring_line_width docstring
AA-Turner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,299 @@ | ||
| OVERLONG_SUMMARY = frozenset(( | ||
| # Lib/test/ | ||
| 'test_preprocessor_guarded_if_e_or_f', | ||
|
|
||
| # Modules/ | ||
| '_abc._abc_init', | ||
| '_abc._abc_instancecheck', | ||
| '_abc._abc_register', | ||
| '_abc._abc_subclasscheck', | ||
| '_codecs.lookup', | ||
| '_ctypes.byref', | ||
| '_curses.can_change_color', | ||
| '_curses.is_term_resized', | ||
| '_curses.mousemask', | ||
| '_curses.reset_prog_mode', | ||
| '_curses.reset_shell_mode', | ||
| '_curses.termname', | ||
| '_curses.window.enclose', | ||
| '_functools.reduce', | ||
| '_gdbm.gdbm.setdefault', | ||
| '_hashlib.HMAC.hexdigest', | ||
| '_hashlib.openssl_shake_128', | ||
| '_hashlib.openssl_shake_256', | ||
| '_hashlib.pbkdf2_hmac', | ||
| '_hmac.HMAC.hexdigest', | ||
| '_interpreters.is_shareable', | ||
| '_io._BufferedIOBase.read1', | ||
| '_lzma._decode_filter_properties', | ||
| '_remote_debugging.RemoteUnwinder.__init__', | ||
| '_remote_debugging.RemoteUnwinder.get_all_awaited_by', | ||
| '_remote_debugging.RemoteUnwinder.get_async_stack_trace', | ||
| '_socket.inet_aton', | ||
| '_sre.SRE_Match.expand', | ||
| '_sre.SRE_Match.groupdict', | ||
| '_sre.SRE_Pattern.finditer', | ||
| '_sre.SRE_Pattern.search', | ||
| '_sre.SRE_Pattern.sub', | ||
| '_sre.SRE_Pattern.subn', | ||
| '_ssl._SSLContext.sni_callback', | ||
| '_ssl._SSLSocket.pending', | ||
| '_ssl._SSLSocket.sendfile', | ||
| '_ssl.get_default_verify_paths', | ||
| '_ssl.RAND_status', | ||
| '_sysconfig.config_vars', | ||
| '_testcapi.make_exception_with_doc', | ||
| '_testcapi.VectorCallClass.set_vectorcall', | ||
| '_tkinter.getbusywaitinterval', | ||
| '_tkinter.setbusywaitinterval', | ||
| '_tracemalloc.reset_peak', | ||
| '_zstd.get_frame_size', | ||
| '_zstd.set_parameter_types', | ||
| '_zstd.ZstdDecompressor.decompress', | ||
| 'array.array.buffer_info', | ||
| 'array.array.frombytes', | ||
| 'array.array.fromfile', | ||
| 'array.array.tobytes', | ||
| 'cmath.isfinite', | ||
| 'datetime.datetime.strptime', | ||
| 'gc.get_objects', | ||
| 'itertools.chain.from_iterable', | ||
| 'itertools.combinations_with_replacement.__new__', | ||
| 'itertools.cycle.__new__', | ||
| 'itertools.starmap.__new__', | ||
| 'itertools.takewhile.__new__', | ||
| 'math.comb', | ||
| 'math.perm', | ||
| 'os.getresgid', | ||
| 'os.lstat', | ||
| 'os.pread', | ||
| 'os.pwritev', | ||
| 'os.sched_getaffinity', | ||
| 'os.sched_rr_get_interval', | ||
| 'os.timerfd_gettime', | ||
| 'os.timerfd_gettime_ns', | ||
| 'os.urandom', | ||
| 'os.WIFEXITED', | ||
| 'os.WTERMSIG', | ||
| 'pwd.getpwall', | ||
| 'pyexpat.xmlparser.ExternalEntityParserCreate', | ||
| 'pyexpat.xmlparser.GetReparseDeferralEnabled', | ||
| 'pyexpat.xmlparser.SetParamEntityParsing', | ||
| 'pyexpat.xmlparser.UseForeignDTD', | ||
| 'readline.redisplay', | ||
| 'signal.set_wakeup_fd', | ||
| 'unicodedata.UCD.combining', | ||
| 'unicodedata.UCD.decomposition', | ||
| 'zoneinfo.ZoneInfo.dst', | ||
| 'zoneinfo.ZoneInfo.tzname', | ||
| 'zoneinfo.ZoneInfo.utcoffset', | ||
|
|
||
| # Objects/ | ||
| 'B.zfill', | ||
| 'bytearray.count', | ||
| 'bytearray.endswith', | ||
| 'bytearray.extend', | ||
| 'bytearray.find', | ||
| 'bytearray.index', | ||
| 'bytearray.maketrans', | ||
| 'bytearray.rfind', | ||
| 'bytearray.rindex', | ||
| 'bytearray.rsplit', | ||
| 'bytearray.split', | ||
| 'bytearray.splitlines', | ||
| 'bytearray.startswith', | ||
| 'bytes.count', | ||
| 'bytes.endswith', | ||
| 'bytes.find', | ||
| 'bytes.index', | ||
| 'bytes.maketrans', | ||
| 'bytes.rfind', | ||
| 'bytes.rindex', | ||
| 'bytes.startswith', | ||
| 'code.replace', | ||
| 'complex.conjugate', | ||
| 'dict.pop', | ||
| 'float.as_integer_ratio', | ||
| 'frame.f_trace', | ||
| 'int.bit_count', | ||
| 'OrderedDict.fromkeys', | ||
| 'OrderedDict.pop', | ||
| 'set.symmetric_difference_update', | ||
| 'str.count', | ||
| 'str.endswith', | ||
| 'str.find', | ||
| 'str.index', | ||
| 'str.isprintable', | ||
| 'str.rfind', | ||
| 'str.rindex', | ||
| 'str.rsplit', | ||
| 'str.split', | ||
| 'str.startswith', | ||
| 'str.strip', | ||
| 'str.swapcase', | ||
| 'str.zfill', | ||
|
|
||
| # PC/ | ||
| 'msvcrt.kbhit', | ||
|
|
||
| # Python/ | ||
| '_jit.is_active', | ||
| '_jit.is_available', | ||
| '_jit.is_enabled', | ||
| 'marshal.dumps', | ||
| 'sys._current_exceptions', | ||
| 'sys._setprofileallthreads', | ||
| 'sys._settraceallthreads', | ||
| )) | ||
|
|
||
| OVERLONG_BODY = frozenset(( | ||
| # Modules/ | ||
| '_bz2.BZ2Decompressor.decompress', | ||
| '_curses.color_content', | ||
| '_curses.flash', | ||
| '_curses.longname', | ||
| '_curses.resize_term', | ||
| '_curses.use_env', | ||
| '_curses.window.border', | ||
| '_curses.window.derwin', | ||
| '_curses.window.getch', | ||
| '_curses.window.getkey', | ||
| '_curses.window.inch', | ||
| '_curses.window.insch', | ||
| '_curses.window.insnstr', | ||
| '_curses.window.is_linetouched', | ||
| '_curses.window.noutrefresh', | ||
| '_curses.window.overlay', | ||
| '_curses.window.overwrite', | ||
| '_curses.window.refresh', | ||
| '_curses.window.scroll', | ||
| '_curses.window.subwin', | ||
| '_curses.window.touchline', | ||
| '_curses_panel.panel.hide', | ||
| '_functools.reduce', | ||
| '_hashlib.HMAC.hexdigest', | ||
| '_hmac.HMAC.hexdigest', | ||
| '_interpreters.capture_exception', | ||
| '_io._IOBase.seek', | ||
| '_io._TextIOBase.detach', | ||
| '_io.FileIO.read', | ||
| '_io.FileIO.readall', | ||
| '_io.FileIO.seek', | ||
| '_io.open', | ||
| '_io.open_code', | ||
| '_lzma.LZMADecompressor.decompress', | ||
| '_multibytecodec.MultibyteCodec.decode', | ||
| '_multibytecodec.MultibyteCodec.encode', | ||
| '_posixsubprocess.fork_exec', | ||
| '_remote_debugging.RemoteUnwinder.__init__', | ||
| '_remote_debugging.RemoteUnwinder.get_all_awaited_by', | ||
| '_remote_debugging.RemoteUnwinder.get_async_stack_trace', | ||
| '_remote_debugging.RemoteUnwinder.get_stack_trace', | ||
| '_socket.socket.send', | ||
| '_sqlite3.Blob.read', | ||
| '_sqlite3.Blob.seek', | ||
| '_sqlite3.Blob.write', | ||
| '_sqlite3.Connection.deserialize', | ||
| '_sqlite3.Connection.serialize', | ||
| '_sqlite3.Connection.set_progress_handler', | ||
| '_sqlite3.Connection.setlimit', | ||
| '_ssl._SSLContext.sni_callback', | ||
| '_ssl._SSLSocket.context', | ||
| '_ssl._SSLSocket.get_channel_binding', | ||
| '_ssl._SSLSocket.sendfile', | ||
| '_tkinter.setbusywaitinterval', | ||
| '_zstd.ZstdCompressor.compress', | ||
| '_zstd.ZstdCompressor.flush', | ||
| '_zstd.ZstdCompressor.set_pledged_input_size', | ||
| '_zstd.ZstdDecompressor.__new__', | ||
| '_zstd.ZstdDecompressor.decompress', | ||
| '_zstd.ZstdDecompressor.unused_data', | ||
| '_zstd.ZstdDict.__new__', | ||
| '_zstd.ZstdDict.as_digested_dict', | ||
| '_zstd.ZstdDict.as_prefix', | ||
| '_zstd.ZstdDict.as_undigested_dict', | ||
| 'array.array.byteswap', | ||
| 'array.array.fromunicode', | ||
| 'array.array.tounicode', | ||
| 'binascii.a2b_base64', | ||
| 'cmath.isclose', | ||
| 'datetime.date.fromtimestamp', | ||
| 'datetime.datetime.fromtimestamp', | ||
| 'datetime.time.strftime', | ||
| 'fcntl.ioctl', | ||
| 'fcntl.lockf', | ||
| 'gc.freeze', | ||
| 'itertools.combinations_with_replacement.__new__', | ||
| 'math.nextafter', | ||
| 'os.fspath', | ||
| 'os.link', | ||
| 'os.listdir', | ||
| 'os.listxattr', | ||
| 'os.lseek', | ||
| 'os.mknod', | ||
| 'os.preadv', | ||
| 'os.pwritev', | ||
| 'os.readinto', | ||
| 'os.rename', | ||
| 'os.replace', | ||
| 'os.setxattr', | ||
| 'pyexpat.xmlparser.GetInputContext', | ||
| 'pyexpat.xmlparser.UseForeignDTD', | ||
| 'select.devpoll', | ||
| 'select.poll', | ||
| 'select.select', | ||
| 'signal.setitimer', | ||
| 'signal.signal', | ||
| 'termios.tcsetwinsize', | ||
| 'zlib.Decompress.decompress', | ||
| 'zlib.ZlibDecompressor.decompress', | ||
|
|
||
| # Objects/ | ||
| 'bytearray.maketrans', | ||
| 'bytearray.partition', | ||
| 'bytearray.replace', | ||
| 'bytearray.rpartition', | ||
| 'bytearray.rsplit', | ||
| 'bytearray.splitlines', | ||
| 'bytearray.strip', | ||
| 'bytes.maketrans', | ||
| 'bytes.partition', | ||
| 'bytes.replace', | ||
| 'bytes.rpartition', | ||
| 'bytes.rsplit', | ||
| 'bytes.splitlines', | ||
| 'bytes.strip', | ||
| 'float.__getformat__', | ||
| 'list.sort', | ||
| 'memoryview.tobytes', | ||
| 'str.capitalize', | ||
| 'str.isalnum', | ||
| 'str.isalpha', | ||
| 'str.isdecimal', | ||
| 'str.isdigit', | ||
| 'str.isidentifier', | ||
| 'str.islower', | ||
| 'str.isnumeric', | ||
| 'str.isspace', | ||
| 'str.isupper', | ||
| 'str.join', | ||
| 'str.partition', | ||
| 'str.removeprefix', | ||
| 'str.replace', | ||
| 'str.rpartition', | ||
| 'str.splitlines', | ||
| 'str.title', | ||
| 'str.translate', | ||
|
|
||
| # PC/ | ||
| '_wmi.exec_query', | ||
|
|
||
| # Python/ | ||
| '__import__', | ||
| '_contextvars.ContextVar.get', | ||
| '_contextvars.ContextVar.reset', | ||
| '_contextvars.ContextVar.set', | ||
| '_imp.acquire_lock', | ||
| 'marshal.dumps', | ||
| 'sys._stats_dump', | ||
| )) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can’t perform that action at this time.
Uh oh!
There was an error while loading. Please reload this page.