cpython (original) (raw)

One other issue, which I just noticed. The Python doc builder has a checker tool that checks for potential problems in the doc source files. The check is run with make -C doc suspicious and is run as part of the CI tests. The checker looks for anything that might be a misspelled Docutils/Sphinx role and so fails on the python:bind ... examples you add. To silence the warnings, you should make the following additions to Doc/tools/susp-ignored.csv in your PR:

--- a/Doc/tools/susp-ignored.csv
+++ b/Doc/tools/susp-ignored.csv
@@ -187,6 +187,8 @@ library/profile,,:lineno,filename:lineno(function)
 library/pyexpat,,:elem1,<py:elem1 />
 library/pyexpat,,:py,"xmlns:py = ""http://www.python.org/ns/"">"
 library/random,,:len,new_diff = mean(combined[:len(drug)]) - mean(combined[len(drug):])
+library/readline,,:bind,"python:bind -v"
+library/readline,,:bind,"python:bind ^I rl_complete"
 library/smtplib,,:port,method must support that as well as a regular host:port
 library/socket,,::,'5aef:2b::8'
 library/socket,,:can,"return (can_id, can_dlc, data[:can_dlc])"